Class Excludes
java.lang.Object
org.exolab.castor.builder.binding.xml.Excludes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addExclude
(int index, Exclude vExclude) void
addExclude
(Exclude vExclude) Method enumerateExclude.Exclude[]
Method getExclude.Returns the contents of the collection in an Array.getExclude
(int index) Method getExclude.int
Method getExcludeCount.boolean
isValid()
Method isValid.Method iterateExclude.void
void
marshal
(ContentHandler handler) void
boolean
removeExclude
(Exclude vExclude) Method removeExclude.removeExcludeAt
(int index) Method removeExcludeAt.void
setExclude
(int index, Exclude vExclude) void
setExclude
(Exclude[] vExcludeArray) static Excludes
unmarshalExcludes
(Reader reader) Method unmarshalExcludes.void
validate()
-
Constructor Details
-
Excludes
public Excludes()
-
-
Method Details
-
addExclude
- Parameters:
vExclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addExclude
- Parameters:
index
-vExclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
enumerateExclude
Method enumerateExclude.- Returns:
- an Enumeration over all possible elements of this collection
-
getExclude
Method getExclude.- Parameters:
index
-- Returns:
- the value of the org.exolab.castor.builder.binding.xml.Exclude at the given index
- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
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
Method iterateExclude.- Returns:
- an Iterator over all possible elements in this collection
-
marshal
- Parameters:
out
-- Throws:
MarshalException
- if object is null or if any SAXException is thrown during marshalingValidationException
- if this object is an invalid instance according to the schema
-
marshal
public void marshal(ContentHandler handler) throws IOException, MarshalException, ValidationException - Parameters:
handler
-- Throws:
IOException
- if an IOException occurs during marshalingValidationException
- if this object is an invalid instance according to the schemaMarshalException
- if object is null or if any SAXException is thrown during marshaling
-
removeAllExclude
public void removeAllExclude() -
removeExclude
Method removeExclude.- Parameters:
vExclude
-- Returns:
- true if the object was removed from the collection.
-
removeExcludeAt
Method removeExcludeAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
setExclude
- Parameters:
index
-vExclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setExclude
- Parameters:
vExcludeArray
-
-
unmarshalExcludes
public static Excludes unmarshalExcludes(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 marshalingValidationException
- if this object is an invalid instance according to the schema
-
validate
- Throws:
ValidationException
- if this object is an invalid instance according to the schema
-