org.exolab.castor.builder.binding.xml
Class FieldType

java.lang.Object
  extended by org.exolab.castor.builder.binding.xml.FieldType
All Implemented Interfaces:
java.io.Serializable

public class FieldType
extends java.lang.Object
implements java.io.Serializable

This type represents the binding for class member. It allows the definition of its name and java type as well as an implementation of FieldHandler to help the Marshalling framework in handling that member. Defining a validator is also possible. The names given for the validator and the fieldHandler must be fully qualified

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
FieldType()
           
 
Method Summary
 void deleteWrapper()
           
 FieldTypeCollectionType getCollection()
          Returns the value of field 'collection'.
 java.lang.String getHandler()
          Returns the value of field 'handler'.
 java.lang.String getJavaType()
          Returns the value of field 'javaType'.
 java.lang.String getName()
          Returns the value of field 'name'.
 java.lang.String getValidator()
          Returns the value of field 'validator'.
 FieldTypeVisibilityType getVisibility()
          Returns the value of field 'visibility'.
 boolean getWrapper()
          Returns the value of field 'wrapper'.
 boolean hasWrapper()
          Method hasWrapper.
 boolean isValid()
          Method isValid.
 boolean isWrapper()
          Returns the value of field 'wrapper'.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setCollection(FieldTypeCollectionType collection)
          Sets the value of field 'collection'.
 void setHandler(java.lang.String handler)
          Sets the value of field 'handler'.
 void setJavaType(java.lang.String javaType)
          Sets the value of field 'javaType'.
 void setName(java.lang.String name)
          Sets the value of field 'name'.
 void setValidator(java.lang.String validator)
          Sets the value of field 'validator'.
 void setVisibility(FieldTypeVisibilityType visibility)
          Sets the value of field 'visibility'.
 void setWrapper(boolean wrapper)
          Sets the value of field 'wrapper'.
static FieldType unmarshalFieldType(java.io.Reader reader)
          Method unmarshalFieldType.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldType

public FieldType()
Method Detail

deleteWrapper

public void deleteWrapper()

getCollection

public FieldTypeCollectionType getCollection()
Returns the value of field 'collection'.

Returns:
the value of field 'Collection'.

getHandler

public java.lang.String getHandler()
Returns the value of field 'handler'.

Returns:
the value of field 'Handler'.

getJavaType

public java.lang.String getJavaType()
Returns the value of field 'javaType'.

Returns:
the value of field 'JavaType'.

getName

public java.lang.String getName()
Returns the value of field 'name'.

Returns:
the value of field 'Name'.

getValidator

public java.lang.String getValidator()
Returns the value of field 'validator'.

Returns:
the value of field 'Validator'.

getVisibility

public FieldTypeVisibilityType getVisibility()
Returns the value of field 'visibility'.

Returns:
the value of field 'Visibility'.

getWrapper

public boolean getWrapper()
Returns the value of field 'wrapper'.

Returns:
the value of field 'Wrapper'.

hasWrapper

public boolean hasWrapper()
Method hasWrapper.

Returns:
true if at least one Wrapper has been added

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

isWrapper

public boolean isWrapper()
Returns the value of field 'wrapper'.

Returns:
the value of field 'Wrapper'.

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException
Parameters:
out -
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
ValidationException - if this object is an invalid instance according to the schema
MarshalException - if object is null or if any SAXException is thrown during marshaling

setCollection

public void setCollection(FieldTypeCollectionType collection)
Sets the value of field 'collection'.

Parameters:
collection - the value of field 'collection'.

setHandler

public void setHandler(java.lang.String handler)
Sets the value of field 'handler'.

Parameters:
handler - the value of field 'handler'.

setJavaType

public void setJavaType(java.lang.String javaType)
Sets the value of field 'javaType'.

Parameters:
javaType - the value of field 'javaType'.

setName

public void setName(java.lang.String name)
Sets the value of field 'name'.

Parameters:
name - the value of field 'name'.

setValidator

public void setValidator(java.lang.String validator)
Sets the value of field 'validator'.

Parameters:
validator - the value of field 'validator'.

setVisibility

public void setVisibility(FieldTypeVisibilityType visibility)
Sets the value of field 'visibility'.

Parameters:
visibility - the value of field 'visibility'.

setWrapper

public void setWrapper(boolean wrapper)
Sets the value of field 'wrapper'.

Parameters:
wrapper - the value of field 'wrapper'.

unmarshalFieldType

public static FieldType unmarshalFieldType(java.io.Reader reader)
                                    throws MarshalException,
                                           ValidationException
Method unmarshalFieldType.

Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.builder.binding.xml.FieldType
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws ValidationException
Throws:
ValidationException - if this object is an invalid instance according to the schema


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com