org.opennms.netmgt.config.groups

Class Group

java.lang.Object

org.opennms.netmgt.config.groups.Group

All Implemented Interfaces:

Serializable

public class Group
extends Object
implements Serializable

Class Group.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDutySchedule(int index, String vDutySchedule)
void	addDutySchedule(String vDutySchedule)
void	addUser(int index, String vUser)
void	addUser(String vUser)
Enumeration<String>	enumerateDutySchedule() Method enumerateDutySchedule.
Enumeration<String>	enumerateUser() Method enumerateUser.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getComments() Returns the value of field 'comments'.
String	getDefaultMap() Returns the value of field 'defaultMap'.
String[]	getDutySchedule() Method getDutySchedule.Returns the contents of the collection in an Array.
String	getDutySchedule(int index) Method getDutySchedule.
List<String>	getDutyScheduleCollection() Method getDutyScheduleCollection.Returns a reference to '_dutyScheduleList'.
int	getDutyScheduleCount() Method getDutyScheduleCount.
String	getName() Returns the value of field 'name'.
String[]	getUser() Method getUser.Returns the contents of the collection in an Array.
String	getUser(int index) Method getUser.
List<String>	getUserCollection() Method getUserCollection.Returns a reference to '_userList'.
int	getUserCount() Method getUserCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<String>	iterateDutySchedule() Method iterateDutySchedule.
Iterator<String>	iterateUser() Method iterateUser.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDutySchedule()
void	removeAllUser()
boolean	removeDutySchedule(String vDutySchedule) Method removeDutySchedule.
String	removeDutyScheduleAt(int index) Method removeDutyScheduleAt.
boolean	removeUser(String vUser) Method removeUser.
String	removeUserAt(int index) Method removeUserAt.
void	setComments(String comments) Sets the value of field 'comments'.
void	setDefaultMap(String defaultMap) Sets the value of field 'defaultMap'.
void	setDutySchedule(int index, String vDutySchedule)
void	setDutySchedule(List<String> vDutyScheduleList) Sets the value of '_dutyScheduleList' by copying the given Vector.
void	setDutySchedule(String[] vDutyScheduleArray)
void	setDutyScheduleCollection(List<String> dutyScheduleList) Deprecated.
void	setName(String name) Sets the value of field 'name'.
void	setUser(int index, String vUser)
void	setUser(List<String> vUserList) Sets the value of '_userList' by copying the given Vector.
void	setUser(String[] vUserArray)
void	setUserCollection(List<String> userList) Deprecated.
static Group	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

Group

public Group()

Method Detail

addDutySchedule

public void addDutySchedule(String vDutySchedule)
                     throws IndexOutOfBoundsException

Parameters:

vDutySchedule -

Throws:

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

addDutySchedule

public void addDutySchedule(int index,
                   String vDutySchedule)
                     throws IndexOutOfBoundsException

Parameters:

index -

vDutySchedule -

Throws:

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

addUser

public void addUser(String vUser)
             throws IndexOutOfBoundsException

Parameters:

vUser -

Throws:

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

addUser

public void addUser(int index,
           String vUser)
             throws IndexOutOfBoundsException

Parameters:

index -

vUser -

Throws:

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

enumerateDutySchedule

public Enumeration<String> enumerateDutySchedule()

Method enumerateDutySchedule.

Returns:

an Enumeration over all possible elements of this collection

enumerateUser

public Enumeration<String> enumerateUser()

Method enumerateUser.

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.

getComments

public String getComments()

Returns the value of field 'comments'.

Returns:

the value of field 'Comments'.

getDefaultMap

public String getDefaultMap()

Returns the value of field 'defaultMap'.

Returns:

the value of field 'DefaultMap'.

getDutySchedule

public String getDutySchedule(int index)
                       throws IndexOutOfBoundsException

Method getDutySchedule.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getDutySchedule

public String[] getDutySchedule()

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

getDutyScheduleCollection

public List<String> getDutyScheduleCollection()

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

Returns:

a reference to the Vector backing this class

getDutyScheduleCount

public int getDutyScheduleCount()

Method getDutyScheduleCount.

Returns:

the size of this collection

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getUser

public String getUser(int index)
               throws IndexOutOfBoundsException

Method getUser.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getUser

public String[] getUser()

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

getUserCollection

public List<String> getUserCollection()

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

Returns:

a reference to the Vector backing this class

getUserCount

public int getUserCount()

Method getUserCount.

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

iterateDutySchedule

public Iterator<String> iterateDutySchedule()

Method iterateDutySchedule.

Returns:

an Iterator over all possible elements in this collection

iterateUser

public Iterator<String> iterateUser()

Method iterateUser.

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

removeAllDutySchedule

public void removeAllDutySchedule()

removeAllUser

public void removeAllUser()

removeDutySchedule

public boolean removeDutySchedule(String vDutySchedule)

Method removeDutySchedule.

Parameters:

vDutySchedule -

Returns:

true if the object was removed from the collection.

removeDutyScheduleAt

public String removeDutyScheduleAt(int index)

Method removeDutyScheduleAt.

Parameters:

index -

Returns:

the element removed from the collection

removeUser

public boolean removeUser(String vUser)

Method removeUser.

Parameters:

vUser -

Returns:

true if the object was removed from the collection.

removeUserAt

public String removeUserAt(int index)

Method removeUserAt.

Parameters:

index -

Returns:

the element removed from the collection

setComments

public void setComments(String comments)

Sets the value of field 'comments'.

Parameters:

comments - the value of field 'comments'.

setDefaultMap

public void setDefaultMap(String defaultMap)

Sets the value of field 'defaultMap'.

Parameters:

defaultMap - the value of field 'defaultMap'.

setDutySchedule

public void setDutySchedule(int index,
                   String vDutySchedule)
                     throws IndexOutOfBoundsException

Parameters:

index -

vDutySchedule -

Throws:

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

setDutySchedule

public void setDutySchedule(String[] vDutyScheduleArray)

Parameters:

vDutyScheduleArray -

setDutySchedule

public void setDutySchedule(List<String> vDutyScheduleList)

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

Parameters:

vDutyScheduleList - the Vector to copy.

setDutyScheduleCollection

public void setDutyScheduleCollection(List<String> dutyScheduleList)

Deprecated.

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

Parameters:

dutyScheduleList - the Vector to set.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setUser

public void setUser(int index,
           String vUser)
             throws IndexOutOfBoundsException

Parameters:

index -

vUser -

Throws:

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

setUser

public void setUser(String[] vUserArray)

Parameters:

vUserArray -

setUser

public void setUser(List<String> vUserList)

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

Parameters:

vUserList - the Vector to copy.

setUserCollection

public void setUserCollection(List<String> userList)

Deprecated.

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

Parameters:

userList - the Vector to set.

unmarshal

public static Group 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.Grou

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