com.messagegears.sdk.v3_1

Class SpamAssassinRules

java.lang.Object

com.messagegears.sdk.v3_1.SpamAssassinRules

All Implemented Interfaces:

java.io.Serializable

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

Class SpamAssassinRules.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpamAssassinRules()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpamAssassinRule(int index, SpamAssassinRule vSpamAssassinRule)
void	addSpamAssassinRule(SpamAssassinRule vSpamAssassinRule)
java.util.Enumeration<? extends SpamAssassinRule>	enumerateSpamAssassinRule() Method enumerateSpamAssassinRule.
SpamAssassinRule[]	getSpamAssassinRule() Method getSpamAssassinRule.Returns the contents of the collection in an Array.
SpamAssassinRule	getSpamAssassinRule(int index) Method getSpamAssassinRule.
int	getSpamAssassinRuleCount() Method getSpamAssassinRuleCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends SpamAssassinRule>	iterateSpamAssassinRule() Method iterateSpamAssassinRule.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllSpamAssassinRule()
boolean	removeSpamAssassinRule(SpamAssassinRule vSpamAssassinRule) Method removeSpamAssassinRule.
SpamAssassinRule	removeSpamAssassinRuleAt(int index) Method removeSpamAssassinRuleAt.
void	setSpamAssassinRule(int index, SpamAssassinRule vSpamAssassinRule)
void	setSpamAssassinRule(SpamAssassinRule[] vSpamAssassinRuleArray)
static SpamAssassinRules	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

SpamAssassinRules

public SpamAssassinRules()

Method Detail

addSpamAssassinRule

public void addSpamAssassinRule(SpamAssassinRule vSpamAssassinRule)
                         throws java.lang.IndexOutOfBoundsException

Parameters:

vSpamAssassinRule -

Throws:

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

addSpamAssassinRule

public void addSpamAssassinRule(int index,
                       SpamAssassinRule vSpamAssassinRule)
                         throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vSpamAssassinRule -

Throws:

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

enumerateSpamAssassinRule

public java.util.Enumeration<? extends SpamAssassinRule> enumerateSpamAssassinRule()

Method enumerateSpamAssassinRule.

Returns:

an Enumeration over all possible elements of this collection

getSpamAssassinRule

public SpamAssassinRule getSpamAssassinRule(int index)
                                     throws java.lang.IndexOutOfBoundsException

Method getSpamAssassinRule.

Parameters:

index -

Returns:

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

Throws:

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

getSpamAssassinRule

public SpamAssassinRule[] getSpamAssassinRule()

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

getSpamAssassinRuleCount

public int getSpamAssassinRuleCount()

Method getSpamAssassinRuleCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSpamAssassinRule

public java.util.Iterator<? extends SpamAssassinRule> iterateSpamAssassinRule()

Method iterateSpamAssassinRule.

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

removeAllSpamAssassinRule

public void removeAllSpamAssassinRule()

removeSpamAssassinRule

public boolean removeSpamAssassinRule(SpamAssassinRule vSpamAssassinRule)

Method removeSpamAssassinRule.

Parameters:

vSpamAssassinRule -

Returns:

true if the object was removed from the collection.

removeSpamAssassinRuleAt

public SpamAssassinRule removeSpamAssassinRuleAt(int index)

Method removeSpamAssassinRuleAt.

Parameters:

index -

Returns:

the element removed from the collection

setSpamAssassinRule

public void setSpamAssassinRule(int index,
                       SpamAssassinRule vSpamAssassinRule)
                         throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vSpamAssassinRule -

Throws:

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

setSpamAssassinRule

public void setSpamAssassinRule(SpamAssassinRule[] vSpamAssassinRuleArray)

Parameters:

vSpamAssassinRuleArray -

unmarshal

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

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