Java APG, Version 1.0
Author Lowell D. Thomas
Copyright © Coast to Coast Research, Inc. 2011

com.coasttocoastresearch.examples.expressions
Enum UExpressions.UdtNames

java.lang.Object
  extended by java.lang.Enum<UExpressions.UdtNames>
      extended by com.coasttocoastresearch.examples.expressions.UExpressions.UdtNames
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UExpressions.UdtNames>
Enclosing class:
UExpressions

public static enum UExpressions.UdtNames
extends java.lang.Enum<UExpressions.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
U_ID
          id = 0, name = "u_id"
 
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 UExpressions.UdtNames valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UExpressions.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

U_ID

public static final UExpressions.UdtNames U_ID
id = 0, name = "u_id"

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 UExpressions.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 UExpressions.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 (UExpressions.UdtNames c : UExpressions.UdtNames.values())
    System.out.println(c);

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

Java APG, Version 1.0
Author Lowell D. Thomas
Copyright © Coast to Coast Research, Inc. 2011

Licence Notification

All the software in this distribution is free software:
you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program in the COPYING file. If not, see GPL, Version 2
or GPL, Version 3 or write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.