Package org.exolab.castor.mapping.xml
Class CacheTypeMapping
java.lang.Object
org.exolab.castor.mapping.xml.CacheTypeMapping
- All Implemented Interfaces:
Serializable
Class CacheTypeMapping.
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
void
Enumeration<? extends Param>
Method enumerateParam.long
Returns the value of field 'capacity'.boolean
getDebug()
Returns the value of field 'debug'.Param[]
getParam()
Method getParam.Returns the contents of the collection in an Array.getParam
(int index) Method getParam.int
Method getParamCount.getType()
Returns the value of field 'type'.boolean
Method hasCapacity.boolean
hasDebug()
Method hasDebug.boolean
isDebug()
Returns the value of field 'debug'.boolean
isValid()
Method isValid.Method iterateParam.void
void
marshal
(ContentHandler handler) void
boolean
removeParam
(Param vParam) Method removeParam.removeParamAt
(int index) Method removeParamAt.void
setCapacity
(long capacity) Sets the value of field 'capacity'.void
setDebug
(boolean debug) Sets the value of field 'debug'.void
void
void
Sets the value of field 'type'.static CacheTypeMapping
Method unmarshal.void
validate()
-
Constructor Details
-
CacheTypeMapping
public CacheTypeMapping()
-
-
Method Details
-
addParam
- Parameters:
vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addParam
- Parameters:
index
-vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
deleteCapacity
public void deleteCapacity() -
deleteDebug
public void deleteDebug() -
enumerateParam
Method enumerateParam.- Returns:
- an Enumeration over all possible elements of this collection
-
getCapacity
public long getCapacity()Returns the value of field 'capacity'.- Returns:
- the value of field 'Capacity'.
-
getDebug
public boolean getDebug()Returns the value of field 'debug'.- Returns:
- the value of field 'Debug'.
-
getParam
Method getParam.- Parameters:
index
-- Returns:
- the value of the org.exolab.castor.mapping.xml.Param at the given index
- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
getParam
Method getParam.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
-
getParamCount
public int getParamCount()Method getParamCount.- Returns:
- the size of this collection
-
getType
Returns the value of field 'type'.- Returns:
- the value of field 'Type'.
-
hasCapacity
public boolean hasCapacity()Method hasCapacity.- Returns:
- true if at least one Capacity has been added
-
hasDebug
public boolean hasDebug()Method hasDebug.- Returns:
- true if at least one Debug has been added
-
isDebug
public boolean isDebug()Returns the value of field 'debug'.- Returns:
- the value of field 'Debug'.
-
isValid
public boolean isValid()Method isValid.- Returns:
- true if this object is valid according to the schema
-
iterateParam
Method iterateParam.- 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
-
removeAllParam
public void removeAllParam() -
removeParam
Method removeParam.- Parameters:
vParam
-- Returns:
- true if the object was removed from the collection.
-
removeParamAt
Method removeParamAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
setCapacity
public void setCapacity(long capacity) Sets the value of field 'capacity'.- Parameters:
capacity
- the value of field 'capacity'.
-
setDebug
public void setDebug(boolean debug) Sets the value of field 'debug'.- Parameters:
debug
- the value of field 'debug'.
-
setParam
- Parameters:
index
-vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setParam
- Parameters:
vParamArray
-
-
setType
Sets the value of field 'type'.- Parameters:
type
- the value of field 'type'.
-
unmarshal
public static CacheTypeMapping unmarshal(Reader reader) throws MarshalException, ValidationException Method unmarshal.- Parameters:
reader
-- Returns:
- the unmarshaled org.exolab.castor.mapping.xml.CacheTypeMapping
- 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
-