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

# Enum ForeignKeyAttributeName

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

Alle implementierten Schnittstellen:
  `Serializable`, `Comparable<ForeignKeyAttributeName>`, `java.lang.constant.Constable`, `SourceAttributeName`

public enum ForeignKeyAttributeName extends Enum<ForeignKeyAttributeName> implements SourceAttributeName
Contains the attribute names of the foreign-key source element which are not defined in the Torque schema. These attributes might be created in the transformation.

Version:
  $Id: ForeignKeyAttributeName.java 1917240 2024-04-21 13:22:54Z tv $

- ## Verschachtelte Klassen - Übersicht

  ## Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum

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

- ## Enum-Konstanten - Übersicht

  Enum-Konstanten
  Enum-Konstante
  Beschreibung
  `FOREIGN_KEY_GETTER`
  The name of the getter method for the foreign key object.
  `REFERENCES_PRIMARY_KEY`
  The name of the attribute containing the information whether the foreign key references the primary key of the foreign table.

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `String`
  `getName()`
  Returns the name of the referenced source element.
  `String`
  `toString()`
  `static ForeignKeyAttributeName`
  `valueOf(String name)`
  Gibt die Enumerationskonstante dieses Typs mit dem angegebenen Namen zurück.
  `static ForeignKeyAttributeName[]`
  `values()`
  Gibt ein Array mit den Konstanten dieses Enum-Typs in der Reihenfolge ihrer Deklaration zurück.

  ### Von Klasse geerbte Methoden java.lang.Enum

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

  ### Von Klasse geerbte Methoden java.lang.Object

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

- ## Enum-Konstanten - Details

  - ### FOREIGN_KEY_GETTER

    public static final ForeignKeyAttributeName FOREIGN_KEY_GETTER
    The name of the getter method for the foreign key object.

  - ### REFERENCES_PRIMARY_KEY

    public static final ForeignKeyAttributeName REFERENCES_PRIMARY_KEY
    The name of the attribute containing the information whether the foreign key references the primary key of the foreign table.

- ## Methodendetails

  - ### values

    public static ForeignKeyAttributeName[] values()
    Gibt ein Array mit den Konstanten dieses Enum-Typs in der Reihenfolge ihrer Deklaration zurück.
    Gibt zurück:
      ein Array mit den Konstanten dieses Enumerationstyps in der Reihenfolge ihrer Deklaration

  - ### valueOf

    public static ForeignKeyAttributeName valueOf(String name)
    Gibt die Enumerationskonstante dieses Typs mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enumerationskonstante in diesem Typ deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)
    Parameter:
      `name` - Name der zurückzugebenden Enumerationskonstante.
    Gibt zurück:
      Enumerationskonstante mit dem angegebenen Namen
    Löst aus:
      `IllegalArgumentException` - wenn dieser Enumerationstyp keine Konstante mit dem angegebenen Namen enthält
      `NullPointerException` - wenn das Argument nicht angegeben wird

  - ### getName

    public String getName()
    Returns the name of the referenced source element.
    Angegeben von:
      `getName` in Schnittstelle `SourceAttributeName`
    Gibt zurück:
      the name of the referenced source element.

  - ### toString

    public String toString()
    Setzt außer Kraft:
      `toString` in Klasse `Enum<ForeignKeyAttributeName>`