Enum Class JavaFieldAttributeName
java.lang.Object
java.lang.Enum<JavaFieldAttributeName>
org.apache.torque.templates.transformer.om.JavaFieldAttributeName
- All Implemented Interfaces:
Serializable,Comparable<JavaFieldAttributeName>,Constable,SourceAttributeName
public enum JavaFieldAttributeName
extends Enum<JavaFieldAttributeName>
implements SourceAttributeName
Defines the standard attributes for a source element representing
a java field (i.e instance variable of a class).
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIn case the field is a collection: The name of the method used to add one object to the collection.The throws clause (excluding "throws " itself) for the adder method.The default value for the field.The description of the field.The access modifier (e.g.In case the field is a collection: The type of the objects contained in the collection.The name of the fieldThe type of the fieldIn case the field can be filled somehow: The name of the method used to fill the field.The access modifier (e.g.The method name of the setter for the field.The throws clause (excluding "throws " itself) for the getter method.In case the field must be initialized on first access, this contains the name of the init method.The throws clause (excluding "throws " itself) for the initializer method.In case the type cannot be instantiated (e.g. is an interface like List), this provides the type of the object the field is initialized with.In case the field must be initialized on first access, this contains the name of the method which returns whether the field has been initialized.The name of the javaBean property name (corresponding to getter/setter name).In case the field is a collection: The name of the method used to reset (null) the collection.The access modifier (e.g.The method name of the getter for the field.The throws clause (excluding "throws " itself) for the setter method. -
Method Summary
Modifier and TypeMethodDescriptiongetName()Returns the name of the referenced source element attribute.toString()static JavaFieldAttributeNameReturns the enum constant of this class with the specified name.static JavaFieldAttributeName[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FIELD_NAME
The name of the field -
FIELD_TYPE
The type of the field -
FIELD_ACCESS_MODIFIER
The access modifier (e.g. "public" ...) for the field. Default is "private" -
FIELD_CONTAINED_TYPE
In case the field is a collection: The type of the objects contained in the collection. -
SETTER_NAME
The method name of the getter for the field. -
GETTER_NAME
The method name of the setter for the field. -
PROPERTY_NAME
The name of the javaBean property name (corresponding to getter/setter name). -
INITIALIZER_NAME
In case the field must be initialized on first access, this contains the name of the init method. -
INITIALIZER_TYPE
In case the type cannot be instantiated (e.g. is an interface like List), this provides the type of the object the field is initialized with. -
IS_INITIALIZED_NAME
In case the field must be initialized on first access, this contains the name of the method which returns whether the field has been initialized. -
ADDER_NAME
In case the field is a collection: The name of the method used to add one object to the collection. -
RESETTER_NAME
In case the field is a collection: The name of the method used to reset (null) the collection. -
FILLER_NAME
In case the field can be filled somehow: The name of the method used to fill the field. -
GETTER_ACCESS_MODIFIER
The access modifier (e.g. "public" ...) for the getter method -
SETTER_ACCESS_MODIFIER
The access modifier (e.g. "public" ...) for the setter method -
GETTER_THROWS
The throws clause (excluding "throws " itself) for the getter method. -
SETTER_THROWS
The throws clause (excluding "throws " itself) for the setter method. -
INITIALIZER_THROWS
The throws clause (excluding "throws " itself) for the initializer method. -
ADDER_THROWS
The throws clause (excluding "throws " itself) for the adder method. -
DEFAULT_VALUE
The default value for the field. This is the value the field is initialized with. -
DESCRIPTION
The description of the field.
-
-
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 attribute.- Specified by:
getNamein interfaceSourceAttributeName- Returns:
- the name of the referenced source element attribute.
-
toString
- Overrides:
toStringin classEnum<JavaFieldAttributeName>
-