Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.mappings.converters

Enum AttributeNamePrefix

java.lang.Object

java.lang.Enum<AttributeNamePrefix>

org.eclipse.persistence.internal.mappings.converters.AttributeNamePrefix

All Implemented Interfaces:

Serializable, Comparable<AttributeNamePrefix>

public enum AttributeNamePrefix
extends Enum<AttributeNamePrefix>

INTERNAL: Attribute name prefixes.

Author:

Tomas Kraus

Enum Constant Summary

Enum Constants

Enum Constant	Description
KEY	INTERNAL: Attribute name prefix is "key".
NULL	INTERNAL: No attribute name prefix.
VALUE	INTERNAL: Attribute name prefix is "value".

Field Summary

Fields

Modifier and Type	Field	Description
static int	LENGTH	INTERNAL: Attribute name prefixes enumeration length.

Method Summary

Modifier and Type	Method	Description
String	getName()	INTERNAL: Get attribute name prefix identifier.
String	toString()	INTERNAL: Get instance value in human readable form.
static AttributeNamePrefix	toValue(String name)	INTERNAL: Returns an AttributeNamePrefix instance with name equal to the specified String.
static AttributeNamePrefix	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeNamePrefix[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final AttributeNamePrefix NULL

INTERNAL: No attribute name prefix.

KEY

public static final AttributeNamePrefix KEY

INTERNAL: Attribute name prefix is "key".

VALUE

public static final AttributeNamePrefix VALUE

INTERNAL: Attribute name prefix is "value".

Field Detail

LENGTH

public static final int LENGTH

INTERNAL: Attribute name prefixes enumeration length.

Method Detail

values

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

Returns:

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

valueOf

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

toValue

public static AttributeNamePrefix toValue(String name)

INTERNAL: Returns an AttributeNamePrefix instance with name equal to the specified String. The AttributeNamePrefix returned represents existing value only if specified String matches any String returned by getName method. Search for name is case sensitive. Otherwise null value is returned.

Parameters:

name - getName() value to search for corresponding AttributeNamePrefix instance.

Returns:

AttributeNamePrefix value represented by String or null if value was not recognized.

getName

public String getName()

INTERNAL: Get attribute name prefix identifier.

Returns:

Attribute name prefix identifier.

toString

public String toString()

INTERNAL: Get instance value in human readable form.

Overrides:

toString in class Enum<AttributeNamePrefix>

Returns:

Instance value in human readable form.