org.opennms.netmgt.config.rancid.adapter
Class Policies

java.lang.Object
  org.opennms.netmgt.config.rancid.adapter.Policies

All Implemented Interfaces:

Serializable

public class Policies
extends Object
implements Serializable

Configuration of Policy functionality

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Policies()

Method Summary

void	addPolicyManage(int index, PolicyManage vPolicyManage)
void	addPolicyManage(PolicyManage vPolicyManage)
Enumeration<PolicyManage>	enumeratePolicyManage() Method enumeratePolicyManage.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
PolicyManage[]	getPolicyManage() Method getPolicyManage.Returns the contents of the collection in an Array.
PolicyManage	getPolicyManage(int index) Method getPolicyManage.
List<PolicyManage>	getPolicyManageCollection() Method getPolicyManageCollection.Returns a reference to '_policyManageList'.
int	getPolicyManageCount() Method getPolicyManageCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<PolicyManage>	iteratePolicyManage() Method iteratePolicyManage.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllPolicyManage()
boolean	removePolicyManage(PolicyManage vPolicyManage) Method removePolicyManage.
PolicyManage	removePolicyManageAt(int index) Method removePolicyManageAt.
void	setPolicyManage(int index, PolicyManage vPolicyManage)
void	setPolicyManage(List<PolicyManage> vPolicyManageList) Sets the value of '_policyManageList' by copying the given Vector.
void	setPolicyManage(PolicyManage[] vPolicyManageArray)
void	setPolicyManageCollection(List<PolicyManage> policyManageList) Deprecated.
static Policies	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Policies

public Policies()

Method Detail

addPolicyManage

public void addPolicyManage(PolicyManage vPolicyManage)
                     throws IndexOutOfBoundsException

Parameters:

vPolicyManage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPolicyManage

public void addPolicyManage(int index,
                            PolicyManage vPolicyManage)
                     throws IndexOutOfBoundsException

Parameters:

index -

vPolicyManage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumeratePolicyManage

public Enumeration<PolicyManage> enumeratePolicyManage()

Method enumeratePolicyManage.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getPolicyManage

public PolicyManage getPolicyManage(int index)
                             throws IndexOutOfBoundsException

Method getPolicyManage.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.rancid.adapter.PolicyManage at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getPolicyManage

public PolicyManage[] getPolicyManage()

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

getPolicyManageCollection

public List<PolicyManage> getPolicyManageCollection()

Method getPolicyManageCollection.Returns a reference to '_policyManageList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getPolicyManageCount

public int getPolicyManageCount()

Method getPolicyManageCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iteratePolicyManage

public Iterator<PolicyManage> iteratePolicyManage()

Method iteratePolicyManage.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(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(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

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

removeAllPolicyManage

public void removeAllPolicyManage()

removePolicyManage

public boolean removePolicyManage(PolicyManage vPolicyManage)

Method removePolicyManage.

Parameters:

vPolicyManage -

Returns:

true if the object was removed from the collection.

removePolicyManageAt

public PolicyManage removePolicyManageAt(int index)

Method removePolicyManageAt.

Parameters:

index -

Returns:

the element removed from the collection

setPolicyManage

public void setPolicyManage(int index,
                            PolicyManage vPolicyManage)
                     throws IndexOutOfBoundsException

Parameters:

index -

vPolicyManage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setPolicyManage

public void setPolicyManage(PolicyManage[] vPolicyManageArray)

Parameters:

vPolicyManageArray -

setPolicyManage

public void setPolicyManage(List<PolicyManage> vPolicyManageList)

Sets the value of '_policyManageList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vPolicyManageList - the Vector to copy.

setPolicyManageCollection

public void setPolicyManageCollection(List<PolicyManage> policyManageList)

Deprecated.

Sets the value of '_policyManageList' by setting it to the given Vector. No type checking is performed.

Parameters:

policyManageList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.rancid.adapter.Policies

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