com.google.code.mojo.license.header
Enum HeaderType

java.lang.Object
  extended by java.lang.Enum<HeaderType>
      extended by com.google.code.mojo.license.header.HeaderType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HeaderType>

public enum HeaderType
extends java.lang.Enum<HeaderType>

Defines the default header definitions available out of the box within this plugin.

Author:
Mathieu Carbou (mathieu.carbou@gmail.com), Cedric Pronzato
See Also:
HeaderDefinition

Enum Constant Summary
APOSTROPHE_STYLE
           
ASP
           
BATCH
           
BRACESSTAR_STYLE
           
DOUBLEDASHES_STYLE
           
DOUBLESLASH_STYLE
           
DOUBLETILDE_STYLE
           
DYNASCRIPT_STYLE
           
DYNASCRIPT3_STYLE
           
EXCLAMATION_STYLE
           
EXCLAMATION3_STYLE
           
FTL
           
FTL_ALT
           
HAML_STYLE
           
JAVADOC_STYLE
           
LUA
           
PERCENT3_STYLE
           
PHP
           
SCRIPT_STYLE
           
SEMICOLON_STYLE
           
SHARPSTAR_STYLE
           
SLASHSTAR_STYLE
           
TEXT
           
UNKNOWN
           
XML_STYLE
           
 
Method Summary
static java.util.Map<java.lang.String,HeaderDefinition> defaultDefinitions()
          Returns the header definitions of every default definitions declared by this enumeration as a map using the header type name as key.
static HeaderType fromName(java.lang.String name)
          Returns the HeaderType declared in this enumeration for the given header type name.
 HeaderDefinition getDefinition()
          Returns the HeaderDefinition which corresponds to this enumeration instance.
static HeaderType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HeaderType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

JAVADOC_STYLE

public static final HeaderType JAVADOC_STYLE

SCRIPT_STYLE

public static final HeaderType SCRIPT_STYLE

HAML_STYLE

public static final HeaderType HAML_STYLE

XML_STYLE

public static final HeaderType XML_STYLE

SEMICOLON_STYLE

public static final HeaderType SEMICOLON_STYLE

APOSTROPHE_STYLE

public static final HeaderType APOSTROPHE_STYLE

EXCLAMATION_STYLE

public static final HeaderType EXCLAMATION_STYLE

DOUBLEDASHES_STYLE

public static final HeaderType DOUBLEDASHES_STYLE

SLASHSTAR_STYLE

public static final HeaderType SLASHSTAR_STYLE

BRACESSTAR_STYLE

public static final HeaderType BRACESSTAR_STYLE

SHARPSTAR_STYLE

public static final HeaderType SHARPSTAR_STYLE

DOUBLETILDE_STYLE

public static final HeaderType DOUBLETILDE_STYLE

DYNASCRIPT_STYLE

public static final HeaderType DYNASCRIPT_STYLE

DYNASCRIPT3_STYLE

public static final HeaderType DYNASCRIPT3_STYLE

PERCENT3_STYLE

public static final HeaderType PERCENT3_STYLE

EXCLAMATION3_STYLE

public static final HeaderType EXCLAMATION3_STYLE

DOUBLESLASH_STYLE

public static final HeaderType DOUBLESLASH_STYLE

PHP

public static final HeaderType PHP

ASP

public static final HeaderType ASP

LUA

public static final HeaderType LUA

FTL

public static final HeaderType FTL

FTL_ALT

public static final HeaderType FTL_ALT

TEXT

public static final HeaderType TEXT

BATCH

public static final HeaderType BATCH

UNKNOWN

public static final HeaderType UNKNOWN
Method Detail

values

public static HeaderType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (HeaderType c : HeaderType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static HeaderType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getDefinition

public HeaderDefinition getDefinition()
Returns the HeaderDefinition which corresponds to this enumeration instance.

Returns:
The header definition.

fromName

public static HeaderType fromName(java.lang.String name)
Returns the HeaderType declared in this enumeration for the given header type name.

Parameters:
name - The header definition type name.
Returns:
The HeaderType declared in this enumeration if found or UNKNOWN.

defaultDefinitions

public static java.util.Map<java.lang.String,HeaderDefinition> defaultDefinitions()
Returns the header definitions of every default definitions declared by this enumeration as a map using the header type name as key.

Returns:
The default definitions declared by this enumeration.


Copyright © 2008-2011 Mathieu Carbou. All Rights Reserved.