Public Member Functions | Protected Member Functions | Protected Attributes

org.exolab.castor.mapping.loader.ClassDescriptorImpl Class Reference

Inheritance diagram for org.exolab.castor.mapping.loader.ClassDescriptorImpl:
org.exolab.castor.mapping.ClassDescriptor

List of all members.

Public Member Functions

 ClassDescriptorImpl (Class javaClass, FieldDescriptor[] fields, FieldDescriptor[] identities, ClassDescriptor extend, ClassDescriptor depend, AccessMode accessMode) throws MappingException
 ClassDescriptorImpl (Class javaClass, FieldDescriptor[] fields, FieldDescriptor[] identities, ClassDescriptor extend, ClassDescriptor depend, AccessMode accessMode, boolean verifyConstructable) throws MappingException
ClassMapping getMapping ()
void setMapping (ClassMapping map)
Class getJavaClass ()
FieldDescriptor[] getFields ()
ClassDescriptor getExtends ()
ClassDescriptor getDepends ()
FieldDescriptor getIdentity ()
FieldDescriptor[] getIdentities ()
AccessMode getAccessMode ()
void checkValidity (Object object) throws ValidityException, IllegalStateException
String toString ()

Protected Member Functions

 ClassDescriptorImpl (Class javaClass)

Protected Attributes

final FieldDescriptor[] _fields
final FieldDescriptor[] _identities

Detailed Description

A basic class descriptor implementation. Engines will extend this class to provide additional functionality.

Author:
Assaf Arkin
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:08:29

Constructor & Destructor Documentation

org.exolab.castor.mapping.loader.ClassDescriptorImpl.ClassDescriptorImpl ( Class  javaClass,
FieldDescriptor[]  fields,
FieldDescriptor[]  identities,
ClassDescriptor  extend,
ClassDescriptor  depend,
AccessMode  accessMode 
) throws MappingException

Constructs a new descriptor for the specified class. When describing inheritence, the descriptor of the parent class should be used and only the fields added in this object must be supplied here.

Parameters:
javaClass The Java type of this class
fields The fields described for this class
identity The field of the identity (key) of this class, may be null
extend The descriptor of the class which this class extends,
accessMode The access mode for this class (null is shared) or null if this is a top-level class
Exceptions:
MappingException The extended descriptor does not match a parent class of this type
org.exolab.castor.mapping.loader.ClassDescriptorImpl.ClassDescriptorImpl ( Class  javaClass,
FieldDescriptor[]  fields,
FieldDescriptor[]  identities,
ClassDescriptor  extend,
ClassDescriptor  depend,
AccessMode  accessMode,
boolean  verifyConstructable 
) throws MappingException

Constructs a new descriptor for the specified class. When describing inheritence, the descriptor of the parent class should be used and only the fields added in this object must be supplied here.

Parameters:
javaClass The Java type of this class
fields The fields described for this class
identity The field of the identity (key) of this class, may be null
extend The descriptor of the class which this class extends,
accessMode The access mode for this class (null is shared) or null if this is a top-level class
Exceptions:
MappingException The extended descriptor does not match a parent class of this type

References org.exolab.castor.mapping.loader.ClassDescriptorImpl._fields, org.exolab.castor.mapping.loader.ClassDescriptorImpl._identities, org.exolab.castor.mapping.FieldDescriptor.getContainingClassDescriptor(), org.exolab.castor.mapping.ClassDescriptor.getIdentity(), and org.exolab.castor.mapping.ClassDescriptor.getJavaClass().

org.exolab.castor.mapping.loader.ClassDescriptorImpl.ClassDescriptorImpl ( Class  javaClass  )  [protected]

Member Function Documentation

void org.exolab.castor.mapping.loader.ClassDescriptorImpl.checkValidity ( Object  object  )  throws ValidityException, IllegalStateException

Checks the object validity. Returns successfully if the object can be stored, is valid, etc, throws an exception otherwise.

Parameters:
object The object
Exceptions:
ValidityException The object is invalid, a required is null, or any other validity violation
IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

References org.exolab.castor.mapping.loader.ClassDescriptorImpl._fields.

AccessMode org.exolab.castor.mapping.loader.ClassDescriptorImpl.getAccessMode (  ) 

Returns the access mode specified for this class.

Returns:
The access mode

Implements org.exolab.castor.mapping.ClassDescriptor.

ClassDescriptor org.exolab.castor.mapping.loader.ClassDescriptorImpl.getDepends (  ) 
ClassDescriptor org.exolab.castor.mapping.loader.ClassDescriptorImpl.getExtends (  ) 

Returns the class descriptor of the class extended by this class.

Returns:
The extended class descriptor

Implements org.exolab.castor.mapping.ClassDescriptor.

FieldDescriptor [] org.exolab.castor.mapping.loader.ClassDescriptorImpl.getFields (  ) 

Returns a list of fields represented by this descriptor.

Returns:
A list of fields

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.loader.ClassDescriptorImpl._fields.

FieldDescriptor [] org.exolab.castor.mapping.loader.ClassDescriptorImpl.getIdentities (  ) 
FieldDescriptor org.exolab.castor.mapping.loader.ClassDescriptorImpl.getIdentity (  ) 

Returns the identity field, null if this class has no identity.

Returns:
The identity field

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.loader.ClassDescriptorImpl._identities.

Class org.exolab.castor.mapping.loader.ClassDescriptorImpl.getJavaClass (  ) 

Returns the Java class represented by this descriptor.

Returns:
The Java class

Implements org.exolab.castor.mapping.ClassDescriptor.

ClassMapping org.exolab.castor.mapping.loader.ClassDescriptorImpl.getMapping (  ) 
void org.exolab.castor.mapping.loader.ClassDescriptorImpl.setMapping ( ClassMapping  map  ) 
String org.exolab.castor.mapping.loader.ClassDescriptorImpl.toString (  ) 

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties