org.jomc.model

Enum JavaIdentifier.NormalizationMode

java.lang.Object

java.lang.Enum<JavaIdentifier.NormalizationMode>

org.jomc.model.JavaIdentifier.NormalizationMode

All Implemented Interfaces:

Serializable, Comparable<JavaIdentifier.NormalizationMode>

Enclosing class:

JavaIdentifier

public static enum JavaIdentifier.NormalizationMode
extends Enum<JavaIdentifier.NormalizationMode>

Normalization modes.

Since:

1.4

Version:

$JOMC: JavaIdentifier.java 4804 2013-04-22 05:07:33Z schulte $

Author:

Christian Schulte

See Also:

JavaIdentifier.normalize(java.lang.String, org.jomc.model.JavaIdentifier.NormalizationMode)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAMEL_CASE Mode to normalize by compacting words using camel-case.
CONSTANT_NAME_CONVENTION Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Constants.
LOWER_CASE Mode to normalize by separating words using '_' and by converting all characters to lower-case.
METHOD_NAME_CONVENTION Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Methods.
UPPER_CASE Mode to normalize by separating words using '_' and by converting all characters to upper-case.
VARIABLE_NAME_CONVENTION Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Variables.

Method Summary

Methods

Modifier and Type	Method and Description
static JavaIdentifier.NormalizationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JavaIdentifier.NormalizationMode[]	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

CAMEL_CASE

public static final JavaIdentifier.NormalizationMode CAMEL_CASE

Mode to normalize by compacting words using camel-case.

LOWER_CASE

public static final JavaIdentifier.NormalizationMode LOWER_CASE

Mode to normalize by separating words using '_' and by converting all characters to lower-case.

UPPER_CASE

public static final JavaIdentifier.NormalizationMode UPPER_CASE

Mode to normalize by separating words using '_' and by converting all characters to upper-case.

CONSTANT_NAME_CONVENTION

public static final JavaIdentifier.NormalizationMode CONSTANT_NAME_CONVENTION

Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Constants.

The names of variables declared class constants and of ANSI constants should be all uppercase with words separated by underscores ("_"). (ANSI constants should be avoided, for ease of debugging.)

METHOD_NAME_CONVENTION

public static final JavaIdentifier.NormalizationMode METHOD_NAME_CONVENTION

Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Methods.

Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.

VARIABLE_NAME_CONVENTION

public static final JavaIdentifier.NormalizationMode VARIABLE_NAME_CONVENTION

Mode to normalize according to the Code Conventions for the Java Programming Language - 9 - Naming Conventions - Variables.

Except for variables, all instance, class, and class constants are in mixed case with a lowercase first letter. Internal words start with capital letters. Variable names should not start with underscore _ or dollar sign $ characters, even though both are allowed. Variable names should be short yet meaningful. The choice of a variable name should be mnemonic - that is - designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary "throwaway" variables. Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters.

Method Detail

values

public static JavaIdentifier.NormalizationMode[] 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 (JavaIdentifier.NormalizationMode c : JavaIdentifier.NormalizationMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavaIdentifier.NormalizationMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null