net.infonode.properties.base

Class PropertyGroup

public class PropertyGroup extends Object

A group of properties. The group have a name and a description. It can also have a super group from which it inherit all it's properties. You can think of a property group as similar to a Java class, and properties similar to class fields.

Version: $Revision: 1.6 $

Author: $Author: jesper $

Constructor Summary
	PropertyGroup(String name, String description) Creates a property group.
	PropertyGroup(PropertyGroup superGroup, String name, String description) Creates a property group with a super group.

Method Summary
void	addProperty(Property property) Add a property to this group.
String	getDescription() Returns the description for this group.
String	getName() Returns the name of this group.
Property[]	getProperties() Returns an array with the properties in this group.
Property	getProperty(int index) Returns the property at the index, This does not include properties in super groups.
Property	getProperty(String name) Returns the property with the given name.
int	getPropertyCount() Returns the number of properties in this group.
PropertyGroup	getSuperGroup() Returns the super group of this group.
boolean	hasProperty(Property property) Returns true if this group or one of it's super groups contains the property.
String	toString()

Constructor Detail

PropertyGroup

public PropertyGroup(String name, String description)

Creates a property group.

Parameters: name the name of the group description the group description

PropertyGroup

public PropertyGroup(PropertyGroup superGroup, String name, String description)

Creates a property group with a super group. All properties in the super group will be inherited to this group.

Parameters: superGroup the super group of this group name the name of the group description the group description

Method Detail

addProperty

public void addProperty(Property property)

Add a property to this group.

Parameters: property the property to add

getDescription

public String getDescription()

Returns the description for this group.

Returns: the description for this group

getName

public String getName()

Returns the name of this group.

Returns: the name of this group

getProperties

public Property[] getProperties()

Returns an array with the properties in this group. This does not include properties in super groups.

Returns: an array with the properties in this group

getProperty

public Property getProperty(int index)

Returns the property at the index, This does not include properties in super groups.

Parameters: index the property index

Returns: the property at the index

getProperty

public Property getProperty(String name)

Returns the property with the given name. This includes properties in super groups.

Parameters: name the property name

Returns: the property with the given name, null if no property was found

getPropertyCount

public int getPropertyCount()

Returns the number of properties in this group. This does not include properties in super groups.

Returns: the number of properties in this group

getSuperGroup

public PropertyGroup getSuperGroup()

Returns the super group of this group.

Returns: the super group of this group, null if it has no super group

hasProperty

public boolean hasProperty(Property property)

Returns true if this group or one of it's super groups contains the property.

Parameters: property the property

Returns: true if this group or one of it's super groups contains the property

toString

public String toString()