Public Member Functions | |
void | setContainingClassDescriptor (ClassDescriptor contClsDesc) |
ClassDescriptor | getContainingClassDescriptor () |
String | getFieldName () |
Class | getFieldType () |
boolean | isTransient () |
boolean | isImmutable () |
boolean | isRequired () |
boolean | isMultivalued () |
ClassDescriptor | getClassDescriptor () |
FieldHandler | getHandler () |
Describes the properties of a field. Implementations will extend this inteface to provide additional properties.
ClassDescriptor org.exolab.castor.mapping.FieldDescriptor.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.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.getClassDescriptor(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.getFieldDescriptor(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
ClassDescriptor org.exolab.castor.mapping.FieldDescriptor.getContainingClassDescriptor | ( | ) |
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.mapping.loader.ClassDescriptorImpl.ClassDescriptorImpl(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), and org.exolab.castor.mapping.loader.DelegateFieldDescriptor.getContainingClassDescriptor().
String org.exolab.castor.mapping.FieldDescriptor.getFieldName | ( | ) |
Returns the name of the field.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.xml.XMLMappingLoader.createDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.equals(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.getFieldName(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate(), org.exolab.castor.xml.FieldValidator.validate(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
Class org.exolab.castor.mapping.FieldDescriptor.getFieldType | ( | ) |
Returns the Java type of the field.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, org.exolab.castor.xml.util.XMLFieldDescriptorImpl, and org.exolab.castor.xml.XMLMappingLoader.ContainerElementFieldDescriptor.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.equals(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.getFieldType(), org.exolab.castor.xml.MarshalFramework.searchInheritance(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
FieldHandler org.exolab.castor.mapping.FieldDescriptor.getHandler | ( | ) |
Returns the handler of the field. In order to persist or marshal a field descriptor will be associated with a handler.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept(), org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.equals(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.getHandler(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate(), org.exolab.castor.xml.FieldValidator.validate(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
boolean org.exolab.castor.mapping.FieldDescriptor.isImmutable | ( | ) |
Returns true if the field type is immutable.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.isImmutable(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
boolean org.exolab.castor.mapping.FieldDescriptor.isMultivalued | ( | ) |
Returns true if the field is multi valued (a collection).
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, org.exolab.castor.xml.util.XMLFieldDescriptorImpl, and org.exolab.castor.xml.XMLFieldDescriptor.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.isMultivalued(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
boolean org.exolab.castor.mapping.FieldDescriptor.isRequired | ( | ) |
Returns true if the field type is required.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.isRequired(), org.exolab.castor.xml.FieldValidator.validate(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
boolean org.exolab.castor.mapping.FieldDescriptor.isTransient | ( | ) |
Returns true if the field is transient. Transient fields are never persisted or marshalled.
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.tools.MappingTool.addClass(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl(), org.exolab.castor.mapping.loader.DelegateFieldDescriptor.isTransient(), org.exolab.castor.xml.FieldValidator.validate(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
void org.exolab.castor.mapping.FieldDescriptor.setContainingClassDescriptor | ( | ClassDescriptor | contClsDesc | ) |
Set the class which contains this field
Implemented in org.exolab.castor.mapping.loader.DelegateFieldDescriptor, org.exolab.castor.mapping.loader.FieldDescriptorImpl, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.
Referenced by org.exolab.castor.mapping.loader.DelegateFieldDescriptor.setContainingClassDescriptor().