Class IdentityInfo

java.lang.Object

org.exolab.castor.builder.info.FieldInfo

org.exolab.castor.builder.info.IdentityInfo

All Implemented Interfaces:

NatureExtendable, PropertyHolder, XMLInfo

public final class IdentityInfo
extends FieldInfo

Version:

$Revision: 7915 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Keith Visco

Field Summary

Fields inherited from class FieldInfo

METHOD_PREFIX_ADD, METHOD_PREFIX_DELETE, METHOD_PREFIX_GET, METHOD_PREFIX_HAS, METHOD_PREFIX_IS, METHOD_PREFIX_SET, READ_METHOD, READ_WRITE_METHODS, WRITE_METHOD

Modifier and Type	Field	Description
protected static final String	METHOD_PREFIX_ADD	Method prefixes for "Add" methods.
protected static final String	METHOD_PREFIX_DELETE	Method prefixes for "Delete" methods.
protected static final String	METHOD_PREFIX_GET	Method prefixes for "Get" methods.
protected static final String	METHOD_PREFIX_HAS	Method prefixes for "Has" methods.
protected static final String	METHOD_PREFIX_IS	Method prefixes for "Is" methods.
protected static final String	METHOD_PREFIX_SET	Method prefixes for "Set" methods.
static final int	READ_METHOD	The Read / Getter method flag.
static final int	READ_WRITE_METHODS	The Read and Write methods flags.
static final int	WRITE_METHOD	The Write / Setter method flag.

Fields inherited from interface XMLInfo

CHOICE_NODE_NAME_ERROR_INDICATION

Modifier and Type	Field	Description
static final String	CHOICE_NODE_NAME_ERROR_INDICATION	Identifies the node name for a choice group.

Constructor Summary

Constructors

Constructor	Description
IdentityInfo(String name, FieldMemberAndAccessorFactory memberAndAccessorFactory)	Creates a new IdentityInfo.

Method Summary

Methods inherited from class FieldInfo

addNature, getComment, getDeclaringClassInfo, getDefaultValue, getDeleteMethodName, getFieldInfoReference, getFixedValue, getHasMethodName, getIsMethodName, getMemberAndAccessorFactory, getMethods, getMethodSuffix, getName, getProperty, getReadMethodName, getSubstitutionGroupMembers, getValidator, getVisibility, getWriteMethodName, getXMLFieldHandler, hasNature, isBound, isContainer, isFinal, isNillable, isStatic, isTransient, requiresHasAndDeleteMethods, setBound, setComment, setContainer, setDeclaringClassInfo, setDefaultValue, setFieldInfoReference, setFinal, setFixedValue, setMethods, setNillable, setProperty, setStatic, setSubstitutionGroupMembers, setTransient, setValidator, setVisibility, setXMLFieldHandler

Modifier and Type	Method	Description
final void	addNature(String nature)	Adds a specified nature.
final String	getComment()	Returns the comment associated with this Member.
final ClassInfo	getDeclaringClassInfo()	Returns the ClassInfo to which this Member was declared, for inheritance reasons.
final String	getDefaultValue()	Returns the default value for this FieldInfo.
final String	getDeleteMethodName()	Returns the name of the delete method for this FieldInfo.
FieldInfo	getFieldInfoReference()	Returns the reference to the FieldInfo instance within the same class.
final String	getFixedValue()	Returns the fixed production for this FieldInfo, or null if no fixed value has been specified.
final String	getHasMethodName()	Returns the name of the has method for this FieldInfo.
final String	getIsMethodName()	Get the 'is' method for this FieldInfo.
FieldMemberAndAccessorFactory	getMemberAndAccessorFactory()	Returns the FieldMemberAndAccessorFactory instance to use to create a JField out of this FieldInfo.
final int	getMethods()	Returns the methods flag that indicates which.
String	getMethodSuffix()	Returns the method suffix for creating method names.
final String	getName()	Returns the name of this FieldInfo.
final Object	getProperty(String name)	Get a property by its name.
final String	getReadMethodName()	Returns the name of the read method for this FieldInfo.
List<String>	getSubstitutionGroupMembers()	Returns the possible substitution groups for this class.
final String	getValidator()	Returns the fully qualified name of the Validator to use.
Object	getVisibility()	Returns this field's 'visibility'.
final String	getWriteMethodName()	Returns the name of the write method for this FieldInfo.
final String	getXMLFieldHandler()	Returns the fully qualified name of the XMLFieldHandler to use.
final boolean	hasNature(String nature)	Checks if a specified nature has been added.
final boolean	isBound()	Returns true if this FieldInfo represents a bound property.
final boolean	isContainer()	Returns true if this FieldInfo describes a container class.
boolean	isFinal()	Indicates whether this field is final.
final boolean	isNillable()	Returns true if this field represents a nillable field.
boolean	isStatic()	Indicates whether this field is static.
final boolean	isTransient()	Returns true if this FieldInfo is a transient member.
final boolean	requiresHasAndDeleteMethods()	Returns true if the "has" and "delete" methods are needed for the field associated with this FieldInfo.
final void	setBound(boolean bound)	Sets whether or not this FieldInfo represents a bound property.
final void	setComment(String comment)	Sets the comment for this Member.
final void	setContainer(boolean isContainer)	Sets whether or not this FieldInfo describes a container field.
final void	setDeclaringClassInfo(ClassInfo declaringClassInfo)	Sets the ClassInfo of the class that declares this field.
final void	setDefaultValue(String defaultValue)	Sets the default value for this FieldInfo.
final void	setFieldInfoReference(FieldInfo fieldInfo)	Sets the name of the field within the same class that is a reference to this field.
final void	setFinal(boolean isFinal)	Sets the "final" status of this FieldInfo.
final void	setFixedValue(String fixedValue)	Sets the fixed value in which instances of this field type must lexically match.
final void	setMethods(int methods)	Sets which methods to create: READ_METHOD, WRITE_METHOD, READ_WRITE_METHODS.
final void	setNillable(boolean nillable)	Sets whether or not this field can be nillable.
final void	setProperty(String name, Object value)	Set a property specified by the name to the passed value.
final void	setStatic(boolean isStatic)	Sets the "static" status of this FieldInfo.
void	setSubstitutionGroupMembers(List<String> substitutionGroupMembers)	Sets the possible substitution groups for this class.
final void	setTransient(boolean isTransient)	Sets the transient status of this FieldInfo.
final void	setValidator(String validator)	Sets the name of the Validator to use.
final void	setVisibility(String visibility)	Sets the visibility of this FieldInfo.
final void	setXMLFieldHandler(String handler)	Sets the name of the XMLfieldHandler to use.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IdentityInfo

public IdentityInfo(String name,
 FieldMemberAndAccessorFactory memberAndAccessorFactory)

Creates a new IdentityInfo.

Parameters:

name - the name of this identity

memberAndAccessorFactory - the FieldMemberAndAccessorFactory to be used