org.exolab.castor.builder
public interface BindingComponent
This interface is the abstraction of any type of source that can interact with the Source Code Generator. From the Source Code Generator point of view, the source document used to generate Java source code is totally transparent and is not exposed.
Specific implementation of that class will represent the source document used. For instance when generating source code from an XML Schema, the source generator will interact with an XMLBindingComponent whereas when generating source code from an UML model object model, the source generator will interact with an UMLBindingComponent (This is obviously just an example, no UML Object Model has been as of today integrated in Castor).
A binding component can be of three different types:
Version: $Revision: 1.2 $ $Date: 2005/03/05 13:41:42 $
Field Summary | |
---|---|
static short | CLASS |
static short | INTERFACE |
static short | MEMBER |
Method Summary | |
---|---|
boolean | equals(Object object)
Returns true if the given Object is equal to this instance of BindingComponent.
|
String | getCollectionType()
Returns the name of collection type such as 'arraylist' in which we will store the different occurrences
of the java member generated to represent that BindingComponent.
|
String | getExtends()
Returns the name of a super class for the current BindingComponent.
|
String[] | getImplements()
Returns an array of the different interface names implemented by the class
that will represent the current BindingComponent. |
String | getJavaClassName()
Returns a valid Java Class Name corresponding to this BindingComponent.
|
String | getJavaMemberName()
Returns a valid Java Member Name corresponding to this BindingComponent.
|
String | getJavaPackage()
Returns the java package associated with this BindingComponent.
|
XSType | getJavaType() Returns the XSType that corresponds to the Java type chosen to represent this BindingComponent. |
int | getLowerBound()
Returns the lower bound of the collection that is generated from
this BindingComponent. |
String | getQualifiedName() Returns a fully qualified java class name. |
short | getType() Returns the type of this component binding. |
int | getUpperBound()
Returns the upper bound of the collection that is generated from
this BindingComponent. |
String | getValidator()
Returns the fully qualified name of the Validator to use.
|
String | getValue()
Returns the default value of the member generated from this binding component.
|
String | getXMLFieldHandler()
Returns the fully qualified name of the XMLFieldHandler to use.
|
boolean | hasBoundProperties()
Returns true if bound properties must be generated for the class
that will represent the current BindingComponent.
|
boolean | hasEquals()
Returns true if equal method must be generated for the class
that will represent the current BindingComponent.
|
int | hashCode()
Returns the hashCode value for this object.
|
boolean | isAbstract()
Returns true if the class generated from the current BindingComponent will
be abstract.
|
boolean | isFinal()
Returns true if the class generated from the current BindingComponent will
be final.
|
boolean | useWrapper()
Returns true if the member represented by that BindingComponent
is to be represented by an Object wrapper. |
Returns: true if the given Object is equal to this instance of BindingComponent.
See Also: java.lang.Object#equals(java.lang.Object)
Returns: a string that represents the collection type such as 'arraylist' name in which we will store the different occurrences of the java member generated to represent that BindingComponent.
Returns: the name of a super class for the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.
Returns: an array of the different interface names implemented by the class that will represent the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.
Returns: a valid Java Class Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java class name.
See Also: BindingComponent
Returns: a valid Java Member Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java member name.
See Also: BindingComponent
Returns: the java package associated with this BindingComponent.
Returns the XSType that corresponds to the Java type chosen to represent this BindingComponent. An XSType is an abstraction of a Java type used in the Source Generator. It wraps a JType as well as the necessary methods to convert to/from String.
Returns: an XSType that corresponds to the Java type chosen to represent this BindingComponent.
Returns: an int representing the lower bound of the collection generated from this BindingComponent.
Returns a fully qualified java class name. This name corresponds to the class name that will be generated from this BindingComponent.
Returns: a fully qualified java class name. This name corresponds to the class name corresponding to this BindingComponent.
Returns the type of this component binding. A component binding can be of three different types:
-1 is returned if the component binding is null.
Returns: the type of this component binding. A component binding can
be of three different types:
-1 is returned if the component binding is null.
Returns: an int representing the lower bound of the collection generated from this BindingComponent. -1 is returned to indicate that the upper bound is uinbounded.
Returns: the fully qualified name of the Validator to use.
Returns: a string representation of default value for the member generated from this binding component.
Returns: the fully qualified name of the XMLFieldHandler to use.
Returns: true if bound properties must be generated for the class the class that will represent the current BindingComponent.
Returns: true if equal method must be generated for the class the class that will represent the current BindingComponent.
Returns: the hashcode value for this object.
See Also: java.lang.Object#hashCode()
Returns: true if the class generated from the current BindingComponent will be abstract.
Returns: true if the class generated from the current BindingComponent will be final.
Returns: true if the member represented by that BindingComponent is to be represented by an Object wrapper.