org.opennms.netmgt.config.groups

Class Roles

java.lang.Object

org.opennms.netmgt.config.groups.Roles

All Implemented Interfaces:

Serializable

public class Roles
extends Object
implements Serializable

Class Roles.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Roles()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(int index, Role vRole)
void	addRole(Role vRole)
Enumeration<Role>	enumerateRole() Method enumerateRole.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Role[]	getRole() Method getRole.Returns the contents of the collection in an Array.
Role	getRole(int index) Method getRole.
List<Role>	getRoleCollection() Method getRoleCollection.Returns a reference to '_roleList'.
int	getRoleCount() Method getRoleCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Role>	iterateRole() Method iterateRole.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllRole()
boolean	removeRole(Role vRole) Method removeRole.
Role	removeRoleAt(int index) Method removeRoleAt.
void	setRole(int index, Role vRole)
void	setRole(List<Role> vRoleList) Sets the value of '_roleList' by copying the given Vector.
void	setRole(Role[] vRoleArray)
void	setRoleCollection(List<Role> roleList) Deprecated.
static Roles	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

Roles

public Roles()

Method Detail

addRole

public void addRole(Role vRole)
             throws IndexOutOfBoundsException

Parameters:

vRole -

Throws:

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

addRole

public void addRole(int index,
           Role vRole)
             throws IndexOutOfBoundsException

Parameters:

index -

vRole -

Throws:

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

enumerateRole

public Enumeration<Role> enumerateRole()

Method enumerateRole.

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.

getRole

public Role getRole(int index)
             throws IndexOutOfBoundsException

Method getRole.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.groups.Role at the given index

Throws:

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

getRole

public Role[] getRole()

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

getRoleCollection

public List<Role> getRoleCollection()

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

Returns:

a reference to the Vector backing this class

getRoleCount

public int getRoleCount()

Method getRoleCount.

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

iterateRole

public Iterator<Role> iterateRole()

Method iterateRole.

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

removeAllRole

public void removeAllRole()

removeRole

public boolean removeRole(Role vRole)

Method removeRole.

Parameters:

vRole -

Returns:

true if the object was removed from the collection.

removeRoleAt

public Role removeRoleAt(int index)

Method removeRoleAt.

Parameters:

index -

Returns:

the element removed from the collection

setRole

public void setRole(int index,
           Role vRole)
             throws IndexOutOfBoundsException

Parameters:

index -

vRole -

Throws:

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

setRole

public void setRole(Role[] vRoleArray)

Parameters:

vRoleArray -

setRole

public void setRole(List<Role> vRoleList)

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

Parameters:

vRoleList - the Vector to copy.

setRoleCollection

public void setRoleCollection(List<Role> roleList)

Deprecated.

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

Parameters:

roleList - the Vector to set.

unmarshal

public static Roles 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.groups.Role

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