org.opennms.web.admin.groups.parsers
Class Group

java.lang.Object
  org.opennms.web.admin.groups.parsers.Group

All Implemented Interfaces:

Cloneable

public class Group
extends Object
implements Cloneable

This is a data class to store the group information from the groups.xml file

Version:

1.1.1.1

Author:

Jason Johns , OpenNMS

Field Summary

static String

GROUP_NAME_PROPERTY

Constructor Summary

Group()
Default constructor, intializes the users list

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener)
void	addUser(String aUser) Adds a username to the list of users
void	clearUsers() Removes all users from the group.
Group	clone()
String	getGroupComments() Returns the comments for the group
GroupInfo	getGroupInfo() Returns the group information for this group
String	getGroupName() Returns the group name
int	getUserCount() Returns a count of the users in the list
List<String>	getUsers() Returns the list of users
boolean	hasUser(String aUser) Returns whether the group has this user in its users list
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removeUser(String aUser) Removes a username from the list of users
void	setGroupComments(String someComments) Sets the comments for the group
void	setGroupInfo(GroupInfo someInfo) Sets the group information for this group
void	setGroupName(String aName) Sets the group name
String	toString() Returns a String representation of the group, used primarily for debugging.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GROUP_NAME_PROPERTY

public static final String GROUP_NAME_PROPERTY

See Also:

Constant Field Values

Constructor Detail

Group

public Group()

Default constructor, intializes the users list

Method Detail

clone

public Group clone()

Overrides:

clone in class Object

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

getGroupInfo

public GroupInfo getGroupInfo()

Returns the group information for this group

Returns:

the group info

setGroupInfo

public void setGroupInfo(GroupInfo someInfo)

Sets the group information for this group

Parameters:

someInfo - the group info

setGroupName

public void setGroupName(String aName)

Sets the group name

Parameters:

aName - the name of the group

getGroupName

public String getGroupName()

Returns the group name

Returns:

the name of the group

setGroupComments

public void setGroupComments(String someComments)

Sets the comments for the group

Parameters:

someComments - the comments for the group

getGroupComments

public String getGroupComments()

Returns the comments for the group

Returns:

the comments for the group

hasUser

public boolean hasUser(String aUser)

Returns whether the group has this user in its users list

Returns:

true if user is in list, false if not

addUser

public void addUser(String aUser)

Adds a username to the list of users

Parameters:

aUser - a new username

removeUser

public void removeUser(String aUser)

Removes a username from the list of users

Parameters:

aUser - the user to remove

clearUsers

public void clearUsers()

Removes all users from the group.

getUsers

public List<String> getUsers()

Returns the list of users

Returns:

the list of users

getUserCount

public int getUserCount()

Returns a count of the users in the list

Returns:

how many users in this group

toString

public String toString()

Returns a String representation of the group, used primarily for debugging.

Overrides:

toString in class Object

Returns:

a string representation