Package org.apache.torque.templates.transformer.om

# Enum Class ReferenceChildElementName

java.lang.Object
java.lang.Enum<ReferenceChildElementName>
org.apache.torque.templates.transformer.om.ReferenceChildElementName

All Implemented Interfaces:
  `Serializable`, `Comparable<ReferenceChildElementName>`, `Constable`, `SourceElementName`

public enum ReferenceChildElementName extends Enum<ReferenceChildElementName> implements SourceElementName
Contains the child elements for a reference source element which are not defined in the Torque schema. These elements might be created in the transformation.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `FOREIGN_COLUMN`
  The element containing the foreign column for the parent reference element.
  `LOCAL_COLUMN`
  The element containing the local column for the parent reference element.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getName()`
  Returns the name of the referenced source element.
  `String`
  `toString()`
  `static ReferenceChildElementName`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static ReferenceChildElementName[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### LOCAL_COLUMN

    public static final ReferenceChildElementName LOCAL_COLUMN
    The element containing the local column for the parent reference element.

  - ### FOREIGN_COLUMN

    public static final ReferenceChildElementName FOREIGN_COLUMN
    The element containing the foreign column for the parent reference element.

- ## Method Details

  - ### values

    public static ReferenceChildElementName[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static ReferenceChildElementName valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### getName

    public String getName()
    Returns the name of the referenced source element.
    Specified by:
      `getName` in interface `SourceElementName`
    Returns:
      the name of the referenced source element.

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Enum<ReferenceChildElementName>`