com.calfater.mailcarbon.binding
Class FolderManagerBinding

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

All Implemented Interfaces:

java.io.Serializable

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

Class FolderManagerBinding.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

FolderManagerBinding()

Method Summary

void	addFolder(int index, java.lang.String vFolder)
void	addFolder(java.lang.String vFolder)
void	deleteMaxAttempts()
java.util.Enumeration<? extends java.lang.String>	enumerateFolder() Method enumerateFolder.
java.lang.String[]	getFolder() Method getFolder.Returns the contents of the collection in an Array.
java.lang.String	getFolder(int index) Method getFolder.
int	getFolderCount() Method getFolderCount.
int	getMaxAttempts() Returns the value of field 'maxAttempts'.
boolean	hasMaxAttempts() Method hasMaxAttempts.
boolean	isValid() Method isValid.
java.util.Iterator<? extends java.lang.String>	iterateFolder() Method iterateFolder.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllFolder()
boolean	removeFolder(java.lang.String vFolder) Method removeFolder.
java.lang.String	removeFolderAt(int index) Method removeFolderAt.
void	setFolder(int index, java.lang.String vFolder)
void	setFolder(java.lang.String[] vFolderArray)
void	setMaxAttempts(int maxAttempts) Sets the value of field 'maxAttempts'.
static FolderManagerBinding	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

FolderManagerBinding

public FolderManagerBinding()

Method Detail

addFolder

public void addFolder(java.lang.String vFolder)
               throws java.lang.IndexOutOfBoundsException

Parameters:

vFolder -

Throws:

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

addFolder

public void addFolder(int index,
                      java.lang.String vFolder)
               throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vFolder -

Throws:

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

deleteMaxAttempts

public void deleteMaxAttempts()

enumerateFolder

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

Method enumerateFolder.

Returns:

an Enumeration over all possible elements of this collection

getFolder

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

Method getFolder.

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

getFolder

public java.lang.String[] getFolder()

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

getFolderCount

public int getFolderCount()

Method getFolderCount.

Returns:

the size of this collection

getMaxAttempts

public int getMaxAttempts()

Returns the value of field 'maxAttempts'.

Returns:

the value of field 'MaxAttempts'.

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

iterateFolder

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

Method iterateFolder.

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

removeAllFolder

public void removeAllFolder()

removeFolder

public boolean removeFolder(java.lang.String vFolder)

Method removeFolder.

Parameters:

vFolder -

Returns:

true if the object was removed from the collection.

removeFolderAt

public java.lang.String removeFolderAt(int index)

Method removeFolderAt.

Parameters:

index -

Returns:

the element removed from the collection

setFolder

public void setFolder(int index,
                      java.lang.String vFolder)
               throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vFolder -

Throws:

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

setFolder

public void setFolder(java.lang.String[] vFolderArray)

Parameters:

vFolderArray -

setMaxAttempts

public void setMaxAttempts(int maxAttempts)

Sets the value of field 'maxAttempts'.

Parameters:

maxAttempts - the value of field 'maxAttempts'.

unmarshal

public static FolderManagerBinding 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.FolderManagerBinding

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