com.messagegears.sdk.v3_1

Class Attachments

java.lang.Object

com.messagegears.sdk.v3_1.Attachments

All Implemented Interfaces:

java.io.Serializable

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

Class Attachments.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Attachments()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachment(Attachment vAttachment)
void	addAttachment(int index, Attachment vAttachment)
java.util.Enumeration<? extends Attachment>	enumerateAttachment() Method enumerateAttachment.
Attachment[]	getAttachment() Method getAttachment.Returns the contents of the collection in an Array.
Attachment	getAttachment(int index) Method getAttachment.
int	getAttachmentCount() Method getAttachmentCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends Attachment>	iterateAttachment() Method iterateAttachment.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllAttachment()
boolean	removeAttachment(Attachment vAttachment) Method removeAttachment.
Attachment	removeAttachmentAt(int index) Method removeAttachmentAt.
void	setAttachment(Attachment[] vAttachmentArray)
void	setAttachment(int index, Attachment vAttachment)
static Attachments	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

Attachments

public Attachments()

Method Detail

addAttachment

public void addAttachment(Attachment vAttachment)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

vAttachment -

Throws:

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

addAttachment

public void addAttachment(int index,
                 Attachment vAttachment)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAttachment -

Throws:

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

enumerateAttachment

public java.util.Enumeration<? extends Attachment> enumerateAttachment()

Method enumerateAttachment.

Returns:

an Enumeration over all possible elements of this collection

getAttachment

public Attachment getAttachment(int index)
                         throws java.lang.IndexOutOfBoundsException

Method getAttachment.

Parameters:

index -

Returns:

the value of the com.messagegears.sdk.v3_1.Attachment at the given index

Throws:

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

getAttachment

public Attachment[] getAttachment()

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

getAttachmentCount

public int getAttachmentCount()

Method getAttachmentCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateAttachment

public java.util.Iterator<? extends Attachment> iterateAttachment()

Method iterateAttachment.

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

removeAllAttachment

public void removeAllAttachment()

removeAttachment

public boolean removeAttachment(Attachment vAttachment)

Method removeAttachment.

Parameters:

vAttachment -

Returns:

true if the object was removed from the collection.

removeAttachmentAt

public Attachment removeAttachmentAt(int index)

Method removeAttachmentAt.

Parameters:

index -

Returns:

the element removed from the collection

setAttachment

public void setAttachment(int index,
                 Attachment vAttachment)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAttachment -

Throws:

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

setAttachment

public void setAttachment(Attachment[] vAttachmentArray)

Parameters:

vAttachmentArray -

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled com.messagegears.sdk.v3_1.Attachments

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