|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.builder.XMLInfo
org.exolab.castor.builder.FieldInfo
public class FieldInfo
A class for representing field members of a Class. FieldInfo objects hold all the information required about a member in order to be able to produce marshal/unmarshal and validation code.
Field Summary | |
---|---|
static int |
READ_METHOD
The Read / Getter method flag |
static int |
READ_WRITE_METHODS
The Read and Write methods flags |
static int |
WRITE_METHOD
The Write / Setter method flag |
Fields inherited from class org.exolab.castor.builder.XMLInfo |
---|
ATTRIBUTE_TYPE, ELEMENT_TYPE, TEXT_TYPE |
Constructor Summary | |
---|---|
FieldInfo(XSType type,
java.lang.String name)
Creates a new FieldInfo with the given XML Schema type and the given member name |
Method Summary | |
---|---|
void |
createAccessMethods(JClass jClass)
Creates the access methods for field associated with this FieldInfo. |
void |
createGetterComment(JDocComment jDocComment)
Creates the Javadoc comments for the getter method associated with this FieldInfo. |
void |
createGetterMethod(JClass jClass)
Creates the getter methods for this FieldInfo |
void |
createHasAndDeleteMethods(JClass jClass)
Creates the "has" and "delete" methods for this field associated with this FieldInfo. |
void |
createJavaField(JClass jClass)
Creates the JMembers for this FieldInfo, sometimes a "field" requires more than one java field for this FieldInfo |
void |
createSetterComment(JDocComment jDocComment)
Creates the Javadoc comments for the setter method associated with this FieldInfo. |
void |
createSetterMethod(JClass jClass)
Creates the setter (mutator) method(s) for this FieldInfo |
void |
generateInitializerCode(JSourceCode jsc)
Creates code for initialization of this Member |
java.lang.String |
getComment()
Returns the comment associated with this Member |
ClassInfo |
getDeclaringClassInfo()
Returns the ClassInfo to which this Member was declared, for inheritance reasons |
java.lang.String |
getDefaultValue()
Returns the default value for this FieldInfo |
java.lang.String |
getDeleteMethodName()
Returns the name of the delete method for this FieldInfo. |
java.lang.String |
getFixedValue()
Returns the fixed production for this FieldInfo, or null if no fixed value has been specified. |
java.lang.String |
getHasMethodName()
Returns the name of the has method for this FieldInfo |
int |
getMethods()
Returns the methods flag that indicates which methods will be created |
java.lang.String |
getName()
Returns the name of this FieldInfo |
java.lang.String |
getReadMethodName()
Returns the name of the read method for this FieldInfo |
java.lang.String |
getValidator()
Returns the fully qualified name of the Validator to use. |
java.lang.String |
getWriteMethodName()
Returns the name of the write method for this FieldInfo |
java.lang.String |
getXMLFieldHandler()
Returns the fully qualified name of the XMLFieldHandler to use. |
boolean |
isBound()
Returns true if this FieldInfo represents a bound property |
boolean |
isContainer()
Returns true if this FieldInfo describes a container class. |
boolean |
isHasAndDeleteMethods()
Returns true if the "has" and "delete" methods are needed for the field associated with this FieldInfo. |
boolean |
isNillable()
Returns true if this field represents a nillable field. |
boolean |
isTransient()
Returns true if this FieldInfo is a transient member. |
protected java.lang.String |
methodSuffix()
Returns the method suffix for creating method names. |
void |
setBound(boolean bound)
Sets whether or not this FieldInfo represents a bound property |
void |
setComment(java.lang.String comment)
Sets the comment for this Member |
void |
setContainer(boolean isContainer)
Sets whether or not this FieldInfo describes a container field. |
void |
setDeclaringClassInfo(ClassInfo declaringClassInfo)
|
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value for this FieldInfo |
void |
setFinal(boolean isFinal)
Sets the "final" status of this FieldInfo. |
void |
setFixedValue(java.lang.String fixedValue)
Sets the fixed value in which instances of this field type must lexically match |
void |
setMethods(int methods)
Sets which methods to create READ_METHOD, WRITE_METHOD, READ_WRITE_METHODS |
void |
setNillable(boolean nillable)
Sets whether or not this field can be nillable. |
void |
setReference(java.lang.String fieldName)
Sets the name of the field within the same class that is a reference to this field. |
void |
setStatic(boolean isStatic)
Sets the "static" status of this FieldInfo. |
void |
setTransient(boolean isTransient)
Sets the transient status of this FieldInfo. |
void |
setValidator(java.lang.String validator)
Sets the name of the Validator to use. |
void |
setXMLFieldHandler(java.lang.String handler)
Sets the name of the XMLfieldHandler to use. |
Methods inherited from class org.exolab.castor.builder.XMLInfo |
---|
getNamespacePrefix, getNamespaceURI, getNodeName, getNodeType, getNodeTypeName, getSchemaType, isMultivalued, isRequired, setMultivalued, setNamespacePrefix, setNamespaceURI, setNodeName, setNodeType, setRequired, setSchemaType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int READ_METHOD
public static final int WRITE_METHOD
public static final int READ_WRITE_METHODS
Constructor Detail |
---|
public FieldInfo(XSType type, java.lang.String name)
type
- the XML Schema type of this membername
- the name of the memberMethod Detail |
---|
public void createJavaField(JClass jClass)
public void createAccessMethods(JClass jClass)
jClass
- the JClass to add the methods tocreateGetterMethod(org.exolab.javasource.JClass)
,
createSetterMethod(org.exolab.javasource.JClass)
,
createHasAndDeleteMethods(org.exolab.javasource.JClass)
public void createGetterComment(JDocComment jDocComment)
jDocComment
- the JDocComment to add the Javadoc
comments to.public void createGetterMethod(JClass jClass)
jClass
- the JClass to add the methods topublic void createHasAndDeleteMethods(JClass jClass)
jClass
- the JClass to add the methods topublic void createSetterComment(JDocComment jDocComment)
jDocComment
- the JDocComment to add the Javadoc
comments to.public void createSetterMethod(JClass jClass)
jClass
- the JClass to add the methods topublic java.lang.String getDefaultValue()
public java.lang.String getFixedValue()
public java.lang.String getDeleteMethodName()
public java.lang.String getHasMethodName()
public java.lang.String getReadMethodName()
public java.lang.String getValidator()
public java.lang.String getWriteMethodName()
public java.lang.String getXMLFieldHandler()
public void generateInitializerCode(JSourceCode jsc)
jsc
- the JSourceCode in which to add the source topublic java.lang.String getComment()
public int getMethods()
public java.lang.String getName()
public boolean isBound()
public boolean isContainer()
public boolean isHasAndDeleteMethods()
public boolean isNillable()
setNillable(boolean)
public boolean isTransient()
public void setComment(java.lang.String comment)
comment
- the comment or description for this Memberpublic ClassInfo getDeclaringClassInfo()
public void setBound(boolean bound)
bound
- the flag when true indicates that this FieldInfo
represents a bound propertypublic void setContainer(boolean isContainer)
isContainer
- the boolean value when true indicates
this class should be a container class.public void setDeclaringClassInfo(ClassInfo declaringClassInfo)
public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- the default valuepublic void setFinal(boolean isFinal)
isFinal
- the boolean indicating the final status,
if true this FieldInfo will be treated as final.public void setFixedValue(java.lang.String fixedValue)
fixedValue
- the fixed production for this FieldInfo
public void setMethods(int methods)
methods
- public void setNillable(boolean nillable)
nillable
- a boolean that when true means the
field may be nil.isNillable()
public void setReference(java.lang.String fieldName)
fieldName
- public void setStatic(boolean isStatic)
isStatic
- the boolean indicating the static status,
if true this FieldInfo will be treated as staticpublic void setTransient(boolean isTransient)
isTransient
- the boolean indicating the transient status,
if true this FieldInfo will be treated as transientpublic void setValidator(java.lang.String validator)
validator
- the fully qualified name of the validator to use.public void setXMLFieldHandler(java.lang.String handler)
handler
- the fully qualified name of the handler to use.protected java.lang.String methodSuffix()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |