com.speedment.runtime.config.util

Enum DocumentUtil.Name

java.lang.Object

java.lang.Enum<DocumentUtil.Name>

com.speedment.runtime.config.util.DocumentUtil.Name

All Implemented Interfaces:

Serializable, Comparable<DocumentUtil.Name>

Enclosing class:

DocumentUtil

public static enum DocumentUtil.Name
extends Enum<DocumentUtil.Name>

An enumeration of the types of names that documents can have. This is used to control which method should be called when parsing the document into a name.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATABASE_NAME The name used in the database to reference this document.
JAVA_NAME A user defined name that is used for the document primarily in generated code.

Method Summary

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

DATABASE_NAME

public static final DocumentUtil.Name DATABASE_NAME

The name used in the database to reference this document.

JAVA_NAME

public static final DocumentUtil.Name JAVA_NAME

A user defined name that is used for the document primarily in generated code.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentUtil.Name 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

of

public String of(HasAlias document)

Returns the appropriate name of the specified document.

Parameters:

document - the document

Returns:

the name