com.pcbsys.nirvana.nAdminAPI.nConfigGroup Class Reference
This class manages a group of nConfigEntry objects that are related. More...Inherits java::util::Observable, and com::pcbsys::foundation::collections::SortedObject.
Public Member Functions | |
| boolean | equals (Object item) |
| Compares this object with the passed object. | |
| boolean | equals (long aLong) |
| Compares this object with the passed object. | |
| nConfigEntry | find (String itemName) throws nAdminIllegalArgumentException |
| Finds a nConfigEntry that matches the name specified from within this group. | |
| String | getDescription () |
| Retrieves the description of this group. | |
| Enumeration | getItems () |
| Returns the group as an Enumeration of all the nConfigEntry objects that the group consists of. | |
| String | getName () |
| Retrieve this groups unique name. | |
| boolean | isReadOnly () |
| Returns whether this config group is read only. | |
| int | Length () |
| Returns the length of the configureation group, ie the number of items. | |
| boolean | lessThan (Object item) |
| Compares this object with the passed object. | |
| boolean | lessThan (long aLong) |
| Compares this object with the passed object. | |
Detailed Description
This class manages a group of nConfigEntry objects that are related.This class extends java.util.Observable so that if new nConfigEntry objects are added to this group the Observer will be notified with the new nConfigEntry
Member Function Documentation
| boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.equals | ( | Object | item | ) |
Compares this object with the passed object.
For internal use only
- Parameters:
-
item Object to compare against
- Returns:
- True if this object is equal to the passed object
| boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.equals | ( | long | aLong | ) |
Compares this object with the passed object.
For internal use only
- Parameters:
-
aLong long to compare against
- Returns:
- True if this object is equal to the passed long
| nConfigEntry com.pcbsys.nirvana.nAdminAPI.nConfigGroup.find | ( | String | itemName | ) | throws nAdminIllegalArgumentException |
Finds a nConfigEntry that matches the name specified from within this group.
- See also:
- nConfigEntry
- Parameters:
-
itemName Name of the nConfigEntry to find as a String
- Returns:
- the nConfigEntry object found or null if the name does not exist within the group
- Exceptions:
-
nAdminIllegalArgumentException is thrown if itemName is null
| String com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getDescription | ( | ) |
Retrieves the description of this group.
- Returns:
- the description of this config group as a String
| Enumeration com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getItems | ( | ) |
Returns the group as an Enumeration of all the nConfigEntry objects that the group consists of.
- See also:
- java.util.Enumeration
- Returns:
- An enumeration of all the nConfigEntry objects that the group consists of
| String com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getName | ( | ) |
Retrieve this groups unique name.
- Returns:
- String name
| boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.isReadOnly | ( | ) |
Returns whether this config group is read only.
- Returns:
- boolean value representing if it's read only
| int com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Length | ( | ) |
Returns the length of the configureation group, ie the number of items.
- Returns:
- The number of config entries in this group
| boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan | ( | Object | item | ) |
Compares this object with the passed object.
For internal use only
- Parameters:
-
item Object to compare against
- Returns:
- True if this object is less than the passed object
| boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan | ( | long | aLong | ) |
Compares this object with the passed object.
For internal use only
- Parameters:
-
aLong long to compare against
- Returns:
- True if this object is less than the passed long
