com.calfater.mailcarbon.binding
Class MessageManagerBinding

java.lang.Object
  com.calfater.mailcarbon.binding.MessageManagerBinding

All Implemented Interfaces:

java.io.Serializable

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

Class MessageManagerBinding.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MessageManagerBinding()

Method Summary

void	addMessage(int index, java.lang.String vMessage)
void	addMessage(java.lang.String vMessage)
void	deleteMaxAttempts()
java.util.Enumeration<? extends java.lang.String>	enumerateMessage() Method enumerateMessage.
int	getMaxAttempts() Returns the value of field 'maxAttempts'.
java.lang.String[]	getMessage() Method getMessage.Returns the contents of the collection in an Array.
java.lang.String	getMessage(int index) Method getMessage.
int	getMessageCount() Method getMessageCount.
boolean	hasMaxAttempts() Method hasMaxAttempts.
boolean	isValid() Method isValid.
java.util.Iterator<? extends java.lang.String>	iterateMessage() Method iterateMessage.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllMessage()
boolean	removeMessage(java.lang.String vMessage) Method removeMessage.
java.lang.String	removeMessageAt(int index) Method removeMessageAt.
void	setMaxAttempts(int maxAttempts) Sets the value of field 'maxAttempts'.
void	setMessage(int index, java.lang.String vMessage)
void	setMessage(java.lang.String[] vMessageArray)
static MessageManagerBinding	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

MessageManagerBinding

public MessageManagerBinding()

Method Detail

addMessage

public void addMessage(java.lang.String vMessage)
                throws java.lang.IndexOutOfBoundsException

Parameters:

vMessage -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addMessage

public void addMessage(int index,
                       java.lang.String vMessage)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vMessage -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteMaxAttempts

public void deleteMaxAttempts()

enumerateMessage

public java.util.Enumeration<? extends java.lang.String> enumerateMessage()

Method enumerateMessage.

Returns:

an Enumeration over all possible elements of this collection

getMaxAttempts

public int getMaxAttempts()

Returns the value of field 'maxAttempts'.

Returns:

the value of field 'MaxAttempts'.

getMessage

public java.lang.String getMessage(int index)
                            throws java.lang.IndexOutOfBoundsException

Method getMessage.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getMessage

public java.lang.String[] getMessage()

Method getMessage.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

getMessageCount

public int getMessageCount()

Method getMessageCount.

Returns:

the size of this collection

hasMaxAttempts

public boolean hasMaxAttempts()

Method hasMaxAttempts.

Returns:

true if at least one MaxAttempts has been added

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateMessage

public java.util.Iterator<? extends java.lang.String> iterateMessage()

Method iterateMessage.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.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,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

java.io.IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllMessage

public void removeAllMessage()

removeMessage

public boolean removeMessage(java.lang.String vMessage)

Method removeMessage.

Parameters:

vMessage -

Returns:

true if the object was removed from the collection.

removeMessageAt

public java.lang.String removeMessageAt(int index)

Method removeMessageAt.

Parameters:

index -

Returns:

the element removed from the collection

setMaxAttempts

public void setMaxAttempts(int maxAttempts)

Sets the value of field 'maxAttempts'.

Parameters:

maxAttempts - the value of field 'maxAttempts'.

setMessage

public void setMessage(int index,
                       java.lang.String vMessage)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vMessage -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setMessage

public void setMessage(java.lang.String[] vMessageArray)

Parameters:

vMessageArray -

unmarshal

public static MessageManagerBinding unmarshal(java.io.Reader reader)
                                       throws org.exolab.castor.xml.MarshalException,
                                              org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled com.calfater.mailcarbon.binding.MessageManagerBinding

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema