com.carma.swagger.doclet.parser

Enum NamingConvention

java.lang.Object

java.lang.Enum<NamingConvention>

com.carma.swagger.doclet.parser.NamingConvention

All Implemented Interfaces:

Serializable, Comparable<NamingConvention>

public enum NamingConvention
extends Enum<NamingConvention>

The NamingConvention represents naming conventions for how items such as fields should be named

Version:

$Id$

Author:

conor.roche

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT_NAME This means the item should use its default name e.g.
LOWER_UNDERSCORE This means the item should use always lowercase with underscores separating words, for example firstName would become first_name, it will use this even if there is a naming annotation or javadoc tag for it
LOWER_UNDERSCORE_UNLESS_OVERRIDDEN This means the item should use lowercase with underscores separating words, for example firstName would become first_name unless there is a naming annotation or javadoc tag for it
LOWERCASE This means the item should always use lowercase even if there is a naming annotation or javadoc tag for it
LOWERCASE_UNLESS_OVERRIDDEN This means the item should use lowercase unless there is a naming annotation or javadoc tag for it
UPPERCASE This means the item should always use uppercase even if there is a naming annotation or javadoc tag for it
UPPERCASE_UNLESS_OVERRIDDEN This means the item should use uppercase unless there is a naming annotation or javadoc tag for it

Method Summary

Methods

Modifier and Type	Method and Description
static NamingConvention	forValue(String value, NamingConvention defaultValue) This gets a naming convention whose name matches the given string, if none matches it will return the given default value.
static String	toLowerUnderscore(String value) This converts a camel case type value into lower underscore form
static NamingConvention	valueOf(String name) Returns the enum constant of this type with the specified name.
static NamingConvention[]	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

DEFAULT_NAME

public static final NamingConvention DEFAULT_NAME

This means the item should use its default name e.g. if it was a field named firstName then this would be firstName. This may be overridden by annotations or tags

LOWERCASE_UNLESS_OVERRIDDEN

public static final NamingConvention LOWERCASE_UNLESS_OVERRIDDEN

This means the item should use lowercase unless there is a naming annotation or javadoc tag for it

UPPERCASE_UNLESS_OVERRIDDEN

public static final NamingConvention UPPERCASE_UNLESS_OVERRIDDEN

This means the item should use uppercase unless there is a naming annotation or javadoc tag for it

LOWER_UNDERSCORE_UNLESS_OVERRIDDEN

public static final NamingConvention LOWER_UNDERSCORE_UNLESS_OVERRIDDEN

This means the item should use lowercase with underscores separating words, for example firstName would become first_name unless there is a naming annotation or javadoc tag for it

LOWERCASE

public static final NamingConvention LOWERCASE

This means the item should always use lowercase even if there is a naming annotation or javadoc tag for it

UPPERCASE

public static final NamingConvention UPPERCASE

This means the item should always use uppercase even if there is a naming annotation or javadoc tag for it

LOWER_UNDERSCORE

public static final NamingConvention LOWER_UNDERSCORE

This means the item should use always lowercase with underscores separating words, for example firstName would become first_name, it will use this even if there is a naming annotation or javadoc tag for it

Method Detail

values

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

Returns:

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

valueOf

public static NamingConvention 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

forValue

public static final NamingConvention forValue(String value,
                        NamingConvention defaultValue)

This gets a naming convention whose name matches the given string, if none matches it will return the given default value.

Parameters:

value - The value to match

defaultValue - The default value if none matches

Returns:

The matching naming convention or the default value if none matched

toLowerUnderscore

public static final String toLowerUnderscore(String value)

This converts a camel case type value into lower underscore form

Parameters:

value - The value to convert

Returns:

The converted value