Package org.exolab.castor.mapping
Interface FieldDescriptor
- All Superinterfaces:
NatureExtendable
,PropertyHolder
- All Known Subinterfaces:
XMLFieldDescriptor
- All Known Implementing Classes:
FieldDescriptorImpl
,XMLContainerElementFieldDescriptor
,XMLFieldDescriptorImpl
Describes the properties of a field. Implementations will extend this inteface to provide
additional properties.
- Version:
- $Revision$ $Date: 2005-12-06 14:55:28 -0700 (Tue, 06 Dec 2005) $
- Author:
- Assaf Arkin, Ralf Joachim
-
Method Summary
Modifier and TypeMethodDescriptionReturns the class descriptor related to the field type.Get the class descriptor which contains this field.Returns the name of the field.Returns the Java type of the field.Returns the handler of the field.boolean
Returns true if the field type is immutable.boolean
Returns true if the field is multivalued (a collection).boolean
Returns true if the field type is required.boolean
Returns true if the field is transient.void
Set the class descriptor which contains this field.Methods inherited from interface org.castor.core.nature.NatureExtendable
addNature, hasNature
Methods inherited from interface org.castor.core.nature.PropertyHolder
getProperty, setProperty
-
Method Details
-
setContainingClassDescriptor
Set the class descriptor which contains this field.- Parameters:
parent
- The class descriptor which contains this field.
-
getContainingClassDescriptor
ClassDescriptor getContainingClassDescriptor()Get the class descriptor which contains this field.- Returns:
- The class descriptor which contains this field.
-
getFieldName
String getFieldName()Returns the name of the field. The field must have a name, even if set through accessor methods.- Returns:
- Field name.
-
getFieldType
-
getClassDescriptor
ClassDescriptor getClassDescriptor()Returns the class descriptor related to the field type. If the field type is a class for which a descriptor exists, this descriptor is returned. If the field type is a class for which no mapping is provided, null is returned.- Returns:
- The class descriptor of the field type, or null.
-
getHandler
FieldHandler getHandler()Returns the handler of the field. In order to persist or marshal a field descriptor will be associated with a handler.- Returns:
- The field handler.
-
isTransient
boolean isTransient()Returns true if the field is transient. Transient fields are never persisted or marshalled.- Returns:
- True if transient field.
-
isImmutable
boolean isImmutable()Returns true if the field type is immutable.- Returns:
- True if the field type is immutable.
-
isRequired
boolean isRequired()Returns true if the field type is required.- Returns:
- True if the field type is required.
-
isMultivalued
boolean isMultivalued()Returns true if the field is multivalued (a collection).- Returns:
- True if the field is multivalued.
-