Container (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.mapping.xml.Container

All Implemented Interfaces:

java.io.Serializable
```
public class Container
extends java.lang.Object
implements java.io.Serializable
```
Class Container.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Container()

Constructors
Constructor	Description
`Container()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deleteDirect()`
`void`	`deleteRequired()`
`java.lang.String`	`getCreateMethod()`	Returns the value of field 'createMethod'.
`java.lang.String`	`getDescription()`	Returns the value of field 'description'.
`boolean`	`getDirect()`	Returns the value of field 'direct'.
`FieldMapping`	`getFieldMapping()`	Returns the value of field 'fieldMapping'.
`java.lang.String`	`getGetMethod()`	Returns the value of field 'getMethod'.
`java.lang.String`	`getName()`	Returns the value of field 'name'.
`boolean`	`getRequired()`	Returns the value of field 'required'.
`java.lang.String`	`getSetMethod()`	Returns the value of field 'setMethod'.
`java.lang.String`	`getType()`	Returns the value of field 'type'.
`boolean`	`hasDirect()`	Method hasDirect.
`boolean`	`hasRequired()`	Method hasRequired.
`boolean`	`isDirect()`	Returns the value of field 'direct'.
`boolean`	`isRequired()`	Returns the value of field 'required'.
`boolean`	`isValid()`	Method isValid.
`void`	`marshal(java.io.Writer out)`
`void`	`marshal(org.xml.sax.ContentHandler handler)`
`void`	`setCreateMethod(java.lang.String createMethod)`	Sets the value of field 'createMethod'.
`void`	`setDescription(java.lang.String description)`	Sets the value of field 'description'.
`void`	`setDirect(boolean direct)`	Sets the value of field 'direct'.
`void`	`setFieldMapping(FieldMapping fieldMapping)`	Sets the value of field 'fieldMapping'.
`void`	`setGetMethod(java.lang.String getMethod)`	Sets the value of field 'getMethod'.
`void`	`setName(java.lang.String name)`	Sets the value of field 'name'.
`void`	`setRequired(boolean required)`	Sets the value of field 'required'.
`void`	`setSetMethod(java.lang.String setMethod)`	Sets the value of field 'setMethod'.
`void`	`setType(java.lang.String type)`	Sets the value of field 'type'.
`static Container`	`unmarshal(java.io.Reader reader)`	Method unmarshal.
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Container
```
public Container()
```
- Method Detail
  - deleteDirect
```
public void deleteDirect()
```
  - deleteRequired
```
public void deleteRequired()
```
  - getCreateMethod
```
public java.lang.String getCreateMethod()
```
    Returns the value of field 'createMethod'.
    
    Returns:
    
    the value of field 'CreateMethod'.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the value of field 'description'.
    
    Returns:
    
    the value of field 'Description'.
  - getDirect
```
public boolean getDirect()
```
    Returns the value of field 'direct'.
    
    Returns:
    
    the value of field 'Direct'.
  - getFieldMapping
```
public FieldMapping getFieldMapping()
```
    Returns the value of field 'fieldMapping'. The field 'fieldMapping' has the following description: The 'field' element is used to describe the property of a Java object.
    
    Returns:
    
    the value of field 'FieldMapping'.
  - getGetMethod
```
public java.lang.String getGetMethod()
```
    Returns the value of field 'getMethod'.
    
    Returns:
    
    the value of field 'GetMethod'.
  - getName
```
public java.lang.String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getRequired
```
public boolean getRequired()
```
    Returns the value of field 'required'.
    
    Returns:
    
    the value of field 'Required'.
  - getSetMethod
```
public java.lang.String getSetMethod()
```
    Returns the value of field 'setMethod'.
    
    Returns:
    
    the value of field 'SetMethod'.
  - getType
```
public java.lang.String getType()
```
    Returns the value of field 'type'.
    
    Returns:
    
    the value of field 'Type'.
  - hasDirect
```
public boolean hasDirect()
```
    Method hasDirect.
    
    Returns:
    
    true if at least one Direct has been added
  - hasRequired
```
public boolean hasRequired()
```
    Method hasRequired.
    
    Returns:
    
    true if at least one Required has been added
  - isDirect
```
public boolean isDirect()
```
    Returns the value of field 'direct'.
    
    Returns:
    
    the value of field 'Direct'.
  - isRequired
```
public boolean isRequired()
```
    Returns the value of field 'required'.
    
    Returns:
    
    the value of field 'Required'.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - 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
  - setCreateMethod
```
public void setCreateMethod(java.lang.String createMethod)
```
    Sets the value of field 'createMethod'.
    
    Parameters:
    
    createMethod - the value of field 'createMethod'.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the value of field 'description'.
    
    Parameters:
    
    description - the value of field 'description'.
  - setDirect
```
public void setDirect(boolean direct)
```
    Sets the value of field 'direct'.
    
    Parameters:
    
    direct - the value of field 'direct'.
  - setFieldMapping
```
public void setFieldMapping(FieldMapping fieldMapping)
```
    Sets the value of field 'fieldMapping'. The field 'fieldMapping' has the following description: The 'field' element is used to describe the property of a Java object.
    
    Parameters:
    
    fieldMapping - the value of field 'fieldMapping'.
  - setGetMethod
```
public void setGetMethod(java.lang.String getMethod)
```
    Sets the value of field 'getMethod'.
    
    Parameters:
    
    getMethod - the value of field 'getMethod'.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setRequired
```
public void setRequired(boolean required)
```
    Sets the value of field 'required'.
    
    Parameters:
    
    required - the value of field 'required'.
  - setSetMethod
```
public void setSetMethod(java.lang.String setMethod)
```
    Sets the value of field 'setMethod'.
    
    Parameters:
    
    setMethod - the value of field 'setMethod'.
  - setType
```
public void setType(java.lang.String type)
```
    Sets the value of field 'type'.
    
    Parameters:
    
    type - the value of field 'type'.
  - unmarshal
```
public static Container unmarshal(java.io.Reader reader)
                           throws MarshalException,
                                  ValidationException
```
    Method unmarshal.
    
    Parameters:
    
    reader -
    
    Returns:
    
    the unmarshaled org.exolab.castor.mapping.xml.Container
    
    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

Class Container

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Container

Method Detail

deleteDirect

deleteRequired

getCreateMethod

getDescription

getDirect

getFieldMapping

getGetMethod

getName

getRequired

getSetMethod

getType

hasDirect

hasRequired

isDirect

isRequired

isValid

marshal

marshal

setCreateMethod

setDescription

setDirect

setFieldMapping

setGetMethod

setName

setRequired

setSetMethod

setType

unmarshal

validate