|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.builder.info.XMLInfo
org.exolab.castor.builder.info.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.info.XMLInfo |
---|
ATTRIBUTE_TYPE, CHOICE_NODE_NAME_ERROR_INDICATION, 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,
boolean useJava50)
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,
boolean useJava50)
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,
boolean useJava50)
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. |
java.lang.String |
getMethodSuffix()
Returns the method suffix for creating method names. |
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.util.List |
getSubstitutionGroupMembers()
Returns the possible substitution groups for this class. |
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. |
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 |
setFieldInfoReference(FieldInfo fieldInfo)
Sets the name of the field within the same class that is a reference to this field. |
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 |
setStatic(boolean isStatic)
Sets the "static" status of this FieldInfo. |
void |
setSubstitutionGroupMembers(java.util.List substitutionGroupMembers)
Sets the possible substitution groups for this class. |
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 |
setVisibility(java.lang.String visibility)
Sets the visibility of this FieldInfo. |
void |
setXMLFieldHandler(java.lang.String handler)
Sets the name of the XMLfieldHandler to use. |
Methods inherited from class org.exolab.castor.builder.info.XMLInfo |
---|
getNamespacePrefix, getNamespaceURI, getNodeName, getNodeType, getNodeTypeName, getSchemaType, isElementDefinition, isMultivalued, isRequired, setElementDefinition, 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 final void createJavaField(JClass jClass)
jClass
- JClass object the Java Fields will be added topublic void createAccessMethods(JClass jClass, boolean useJava50)
jClass
- the JClass to add the methods touseJava50
- true if source code is supposed to be generated for Java 5createGetterMethod(org.exolab.javasource.JClass, boolean)
,
createSetterMethod(org.exolab.javasource.JClass, boolean)
,
createHasAndDeleteMethods(org.exolab.javasource.JClass)
public final void createGetterComment(JDocComment jDocComment)
jDocComment
- the JDocComment to add the Javadoc comments to.public final void createGetterMethod(JClass jClass, boolean useJava50)
jClass
- the JClass to add the methods touseJava50
- true if source code is supposed to be generated for Java 5public final void createHasAndDeleteMethods(JClass jClass)
jClass
- the JClass to add the methods topublic final void createSetterComment(JDocComment jDocComment)
jDocComment
- the JDocComment to add the Javadoc comments to.public final void createSetterMethod(JClass jClass, boolean useJava50)
jClass
- the JClass to add the methods touseJava50
- true if source code is supposed to be generated for Java 5public final java.lang.String getDefaultValue()
public final java.lang.String getFixedValue()
NOTE: Fixed values are NOT the same as default values
public final java.lang.String getDeleteMethodName()
public final java.lang.String getHasMethodName()
public final java.lang.String getReadMethodName()
public final java.lang.String getValidator()
public final java.lang.String getWriteMethodName()
public final java.lang.String getXMLFieldHandler()
public void generateInitializerCode(JSourceCode jsc)
jsc
- the JSourceCode in which to add the source topublic final java.lang.String getComment()
public final int getMethods()
public final java.lang.String getName()
public final boolean isBound()
public final boolean isContainer()
public final boolean isHasAndDeleteMethods()
public final boolean isNillable()
setNillable(boolean)
public final boolean isTransient()
public final void setComment(java.lang.String comment)
comment
- the comment or description for this Memberpublic final ClassInfo getDeclaringClassInfo()
public final void setBound(boolean bound)
bound
- the flag when true indicates that this FieldInfo represents a
bound property.public final void setContainer(boolean isContainer)
isContainer
- the boolean value when true indicates this class should be a
container class.public final void setDeclaringClassInfo(ClassInfo declaringClassInfo)
public final void setDefaultValue(java.lang.String defaultValue)
defaultValue
- the default valuepublic final void setFinal(boolean isFinal)
isFinal
- the boolean indicating the final status, if true this
FieldInfo will be treated as final.public final void setFixedValue(java.lang.String fixedValue)
fixedValue
- the fixed production for this FieldInfopublic final void setMethods(int methods)
methods
- a flag describing which methods to create.public final void setNillable(boolean nillable)
nillable
- a boolean that when true means the field may be nil.isNillable()
public final void setFieldInfoReference(FieldInfo fieldInfo)
fieldInfo
- public final void setStatic(boolean isStatic)
isStatic
- the boolean indicating the static status, if true this
FieldInfo will be treated as staticpublic final void setTransient(boolean isTransient)
isTransient
- the boolean indicating the transient status, if true this
FieldInfo will be treated as transientpublic final void setValidator(java.lang.String validator)
validator
- the fully qualified name of the validator to use.public final void setXMLFieldHandler(java.lang.String handler)
handler
- the fully qualified name of the handler to use.public java.lang.String getMethodSuffix()
public final void setVisibility(java.lang.String visibility)
visibility
- the visibility of this FieldInfo.public void setSubstitutionGroupMembers(java.util.List substitutionGroupMembers)
substitutionGroupMembers
- Possible substitution groups for this class.public java.util.List getSubstitutionGroupMembers()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |