org.opennms.netmgt.config.views

Class Membership

java.lang.Object

org.opennms.netmgt.config.views.Membership

All Implemented Interfaces:

Serializable

public class Membership
extends Object
implements Serializable

Class Membership.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Membership()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(int index, Member vMember)
void	addMember(Member vMember)
Enumeration<Member>	enumerateMember() Method enumerateMember.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Member[]	getMember() Method getMember.Returns the contents of the collection in an Array.
Member	getMember(int index) Method getMember.
List<Member>	getMemberCollection() Method getMemberCollection.Returns a reference to '_memberList'.
int	getMemberCount() Method getMemberCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Member>	iterateMember() Method iterateMember.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMember()
boolean	removeMember(Member vMember) Method removeMember.
Member	removeMemberAt(int index) Method removeMemberAt.
void	setMember(int index, Member vMember)
void	setMember(List<Member> vMemberList) Sets the value of '_memberList' by copying the given Vector.
void	setMember(Member[] vMemberArray)
void	setMemberCollection(List<Member> memberList) Deprecated.
static Membership	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

Membership

public Membership()

Method Detail

addMember

public void addMember(Member vMember)
               throws IndexOutOfBoundsException

Parameters:

vMember -

Throws:

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

addMember

public void addMember(int index,
             Member vMember)
               throws IndexOutOfBoundsException

Parameters:

index -

vMember -

Throws:

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

enumerateMember

public Enumeration<Member> enumerateMember()

Method enumerateMember.

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.

getMember

public Member getMember(int index)
                 throws IndexOutOfBoundsException

Method getMember.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.views.Member at the given index

Throws:

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

getMember

public Member[] getMember()

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

getMemberCollection

public List<Member> getMemberCollection()

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

Returns:

a reference to the Vector backing this class

getMemberCount

public int getMemberCount()

Method getMemberCount.

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

iterateMember

public Iterator<Member> iterateMember()

Method iterateMember.

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

removeAllMember

public void removeAllMember()

removeMember

public boolean removeMember(Member vMember)

Method removeMember.

Parameters:

vMember -

Returns:

true if the object was removed from the collection.

removeMemberAt

public Member removeMemberAt(int index)

Method removeMemberAt.

Parameters:

index -

Returns:

the element removed from the collection

setMember

public void setMember(int index,
             Member vMember)
               throws IndexOutOfBoundsException

Parameters:

index -

vMember -

Throws:

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

setMember

public void setMember(Member[] vMemberArray)

Parameters:

vMemberArray -

setMember

public void setMember(List<Member> vMemberList)

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

Parameters:

vMemberList - the Vector to copy.

setMemberCollection

public void setMemberCollection(List<Member> memberList)

Deprecated.

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

Parameters:

memberList - the Vector to set.

unmarshal

public static Membership 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.views.Membership

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