com.coasttocoastresearch.examples.mailbox
Enum UMailbox.UdtNames

java.lang.Object
  java.lang.Enum<UMailbox.UdtNames>
      com.coasttocoastresearch.examples.mailbox.UMailbox.UdtNames

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UMailbox.UdtNames>

Enclosing class:

UMailbox

public static enum UMailbox.UdtNames
extends java.lang.Enum<UMailbox.UdtNames>

This enum provides easy to remember enum constants for locating the UDT identifiers and names. The enum constants have the same spelling as the UDT names rendered in all caps with underscores replacing hyphens.

Enum Constant Summary

E_LDH_STR
id = 1, name = "e_ldh-str"

U_ATOM
id = 2, name = "u_atom"

U_DCONTENT
id = 5, name = "u_dcontent"

U_IPV6_HEX
id = 6, name = "u_ipv6-hex"

U_LET_DIG
id = 0, name = "u_let-dig"

U_SNUM
id = 3, name = "u_snum"

U_STANDARDIZED_TAG
id = 4, name = "u_standardized-tag"

Method Summary

int	udtID() Associates the enum with an identifier for the UDT it represents.
boolean	udtMayBeEmpty() Associates the enum with the "empty" attribute of the UDT it represents.
java.lang.String	udtName() Associates the enum with the original grammar name of the UDT it represents.
static UMailbox.UdtNames	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UMailbox.UdtNames[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

E_LDH_STR

public static final UMailbox.UdtNames E_LDH_STR

id = 1, name = "e_ldh-str"

U_ATOM

public static final UMailbox.UdtNames U_ATOM

id = 2, name = "u_atom"

U_DCONTENT

public static final UMailbox.UdtNames U_DCONTENT

id = 5, name = "u_dcontent"

U_IPV6_HEX

public static final UMailbox.UdtNames U_IPV6_HEX

id = 6, name = "u_ipv6-hex"

U_LET_DIG

public static final UMailbox.UdtNames U_LET_DIG

id = 0, name = "u_let-dig"

U_SNUM

public static final UMailbox.UdtNames U_SNUM

id = 3, name = "u_snum"

U_STANDARDIZED_TAG

public static final UMailbox.UdtNames U_STANDARDIZED_TAG

id = 4, name = "u_standardized-tag"

Method Detail

udtID

public int udtID()

Associates the enum with an identifier for the UDT it represents.

Returns:

the UDT identifier.

udtMayBeEmpty

public boolean udtMayBeEmpty()

Associates the enum with the "empty" attribute of the UDT it represents.

Returns:

the "empty" attribute. True if the UDT name begins with "e_", false if it begins with "u_".

udtName

public java.lang.String udtName()

Associates the enum with the original grammar name of the UDT it represents.

Returns:

the original grammar UDT name.

valueOf

public static UMailbox.UdtNames valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

values

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

Returns:

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