public class PropertyGroup
extends java.lang.Object
PropertyGroup contains properties and/or other property groups.| Constructor and Description |
|---|
PropertyGroup()
This is an empty constructor, in the implementation MUST be implemented.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.ArrayList<PropertyGroup> |
getGroups()
Returns the property groups contained in this group, not in the whole subtree.
|
int |
getId()
Gets the integer value of the unique identifier
PropertyGroupID of the group. |
java.lang.String |
getName()
Gets the name of the unique identifier
PropertyGroupID of the group. |
java.util.ArrayList<Property> |
getProperties()
Returns the properties contained in this group, not in the whole subtree.
|
Property |
getPropertyById(int id)
Gets the
Property, belonging to this group's subtree, whose identifier has the given integer value in PropertyID. |
Property |
getPropertyByName(java.lang.String name)
Gets the
Property, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyID. |
PropertyGroup |
getPropertyGroupById(int id)
Gets the
PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID. |
PropertyGroup |
getPropertyGroupByName(java.lang.String name)
Gets the
PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID. |
boolean |
isFullySupported()
Deprecated.
no more to be used
|
boolean |
isSupported()
Tells if this property group is supported by the underling decoding
hardware.
|
int |
load(PropertyGetter from)
Deprecated.
no more to be used
|
void |
setToDefault()
Resets to the default value all the properties contained in the subtree.
|
int |
store(PropertyEditor to,
boolean persist)
Deprecated.
no more to be used
|
public PropertyGroup()
public java.util.ArrayList<Property> getProperties()
public java.util.ArrayList<PropertyGroup> getGroups()
public Property getPropertyById(int id)
Property, belonging to this group's subtree, whose identifier has the given integer value in PropertyID.
If a property with the given id is not found NULL is returned.
If the returned property is not supported, get and set on the property will fail.id - int unique identifier of the requested property.Property.public Property getPropertyByName(java.lang.String name)
Property, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyID.
If a property with the given name is not found NULL is returned.
If the returned property is not supported, get and set on the property will fail.name - String defining string of the unique identifier of the requested property.Property.public PropertyGroup getPropertyGroupById(int id)
PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID.id - int unique identifier of the requested group.PropertyGroup.public PropertyGroup getPropertyGroupByName(java.lang.String name)
PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID.name - String name of the requested group.PropertyGroup.public java.lang.String getName()
PropertyGroupID of the group.public int getId()
PropertyGroupID of the group.public void setToDefault()
ConfigurationManager.commit() must be called.@Deprecated public int load(PropertyGetter from)
from - The PropertyGetter called to synchronize the current values.int ConfigException.SUCCESS in case of success,
otherwise a possible error code, matching one of the ConfigException error constants.ConfigException - in case of error, when exceptions are enabled through the ErrorManager singleton.@Deprecated public int store(PropertyEditor to, boolean persist)
to - The PropertyEditor in charge of applying the desired values.persist - boolean if true the configuration is saved in a persistent way across
system reboots.int ConfigException.SUCCESS in case of success,
otherwise a possible error code, matching one of the ConfigException error constants.ConfigException - in case of error, when exceptions are enabled through the ErrorManager singleton.public boolean isSupported()
@Deprecated public boolean isFullySupported()