Excludes (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.builder.binding.xml.Excludes

All Implemented Interfaces:

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Excludes()

Constructors
Constructor	Description
`Excludes()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addExclude(int index, Exclude vExclude)`
`void`	`addExclude(Exclude vExclude)`
`java.util.Enumeration`	`enumerateExclude()`	Method enumerateExclude.
`Exclude[]`	`getExclude()`	Method getExclude.Returns the contents of the collection in an Array.
`Exclude`	`getExclude(int index)`	Method getExclude.
`int`	`getExcludeCount()`	Method getExcludeCount.
`boolean`	`isValid()`	Method isValid.
`java.util.Iterator`	`iterateExclude()`	Method iterateExclude.
`void`	`marshal(java.io.Writer out)`
`void`	`marshal(org.xml.sax.ContentHandler handler)`
`void`	`removeAllExclude()`
`boolean`	`removeExclude(Exclude vExclude)`	Method removeExclude.
`Exclude`	`removeExcludeAt(int index)`	Method removeExcludeAt.
`void`	`setExclude(int index, Exclude vExclude)`
`void`	`setExclude(Exclude[] vExcludeArray)`
`static Excludes`	`unmarshalExcludes(java.io.Reader reader)`	Method unmarshalExcludes.
`void`	`validate()`

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

- Constructor Detail
  - Excludes
```
public Excludes()
```
- Method Detail
  - addExclude
```
public void addExclude(Exclude vExclude)
                throws java.lang.IndexOutOfBoundsException
```
    Parameters:
    
    vExclude -
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addExclude
```
public void addExclude(int index,
                       Exclude vExclude)
                throws java.lang.IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vExclude -
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateExclude
```
public java.util.Enumeration enumerateExclude()
```
    Method enumerateExclude.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - getExclude
```
public Exclude getExclude(int index)
                   throws java.lang.IndexOutOfBoundsException
```
    Method getExclude.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.exolab.castor.builder.binding.xml.Exclude at the given index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getExclude
```
public Exclude[] getExclude()
```
    Method getExclude.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getExcludeCount
```
public int getExcludeCount()
```
    Method getExcludeCount.
    
    Returns:
    
    the size of this collection
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - iterateExclude
```
public java.util.Iterator iterateExclude()
```
    Method iterateExclude.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - 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
  - removeAllExclude
```
public void removeAllExclude()
```
  - removeExclude
```
public boolean removeExclude(Exclude vExclude)
```
    Method removeExclude.
    
    Parameters:
    
    vExclude -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeExcludeAt
```
public Exclude removeExcludeAt(int index)
```
    Method removeExcludeAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setExclude
```
public void setExclude(int index,
                       Exclude vExclude)
                throws java.lang.IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vExclude -
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setExclude
```
public void setExclude(Exclude[] vExcludeArray)
```
    Parameters:
    
    vExcludeArray -
  - unmarshalExcludes
```
public static Excludes unmarshalExcludes(java.io.Reader reader)
                                  throws MarshalException,
                                         ValidationException
```
    Method unmarshalExcludes.
    
    Parameters:
    
    reader -
    
    Returns:
    
    the unmarshaled org.exolab.castor.builder.binding.xml.Excludes
    
    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 Excludes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Excludes

Method Detail

addExclude

addExclude

enumerateExclude

getExclude

getExclude

getExcludeCount

isValid

iterateExclude

marshal

marshal

removeAllExclude

removeExclude

removeExcludeAt

setExclude

setExclude

unmarshalExcludes

validate