org.faktorips.runtime.model.type

Enum DocumentationKind

java.lang.Object

java.lang.Enum<DocumentationKind>

org.faktorips.runtime.model.type.DocumentationKind

All Implemented Interfaces:

Serializable, Comparable<DocumentationKind>

public enum DocumentationKind
extends Enum<DocumentationKind>

Different kinds of documentation messages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCRIPTION
LABEL
PLURAL_LABEL

Field Summary

Fields

Modifier and Type	Field and Description
static String	QNAME_SEPARATOR

Method Summary

Modifier and Type	Method and Description
String	getKey(String objectName, String objectType, String partName) Creates a unique key to identify a message of this kind, using the objectName, qualified name type and partName separated by QNAME_SEPARATOR and appending the name of the current message kind.
static DocumentationKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentationKind[]	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

LABEL

public static final DocumentationKind LABEL

PLURAL_LABEL

public static final DocumentationKind PLURAL_LABEL

DESCRIPTION

public static final DocumentationKind DESCRIPTION

Field Detail

QNAME_SEPARATOR

public static final String QNAME_SEPARATOR

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getKey

public String getKey(String objectName,
                     String objectType,
                     String partName)

Creates a unique key to identify a message of this kind, using the objectName, qualified name type and partName separated by QNAME_SEPARATOR and appending the name of the current message kind.