Enum Class ForeignKeyAttributeName
java.lang.Object
java.lang.Enum<ForeignKeyAttributeName>
org.apache.torque.templates.transformer.om.ForeignKeyAttributeName
- All Implemented Interfaces:
Serializable,Comparable<ForeignKeyAttributeName>,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 $
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe name of the getter method for the foreign key object.The name of the attribute containing the information whether the foreign key references the primary key of the foreign table. -
Method Summary
Modifier and TypeMethodDescriptiongetName()Returns the name of the referenced source element.toString()static ForeignKeyAttributeNameReturns the enum constant of this class with the specified name.static ForeignKeyAttributeName[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getName
Returns the name of the referenced source element.- Specified by:
getNamein interfaceSourceAttributeName- Returns:
- the name of the referenced source element.
-
toString
- Overrides:
toStringin classEnum<ForeignKeyAttributeName>
-