public class

PropertyGroup

extends Object
java.lang.Object
   ↳ com.datalogic.device.configuration.PropertyGroup
Known Direct Subclasses

Class Overview

PropertyGroup contains properties and/or other property groups.

Summary

Public Methods
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.
String getName()
Gets the name of the unique identifierPropertyGroupID of the group.
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(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(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()
Tells if this property group is completely supported by the underling decoding hardware.
boolean isSupported()
Tells if this property group is supported by the underling decoding hardware.
int load(PropertyGetter from)
Load the properties values contained by this group from the PropertyGetter.
void setToDefault()
Resets to the default value all the properties contained in the subtree.
int store(PropertyEditor to, boolean persist)
Store the properties values contained by this property into the PropertyEditor.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public ArrayList<PropertyGroup> getGroups ()

Added in revision 1

Returns the property groups contained in this group, not in the whole subtree.

Returns
  • ArrayList of property groups contained in the group.
    Empty if there are no other property groups in this group, not in the whole subtree.

public int getId ()

Added in revision 27

Gets the integer value of the unique identifier PropertyGroupID of the group.

Returns
  • int.

public String getName ()

Added in revision 27

Gets the name of the unique identifierPropertyGroupID of the group.

Returns
  • String.

public ArrayList<Property> getProperties ()

Added in revision 1

Returns the properties contained in this group, not in the whole subtree.

Returns
  • ArrayList of properties contained in the group.
    Empty if there are no properties in this group, not in the whole subtree.

public Property getPropertyById (int id)

Added in revision 27

Gets the 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.

Parameters
id int unique identifier of the requested property.
Returns

public Property getPropertyByName (String name)

Added in revision 27

Gets the 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.

Parameters
name String defining string of the unique identifier of the requested property.
Returns

public PropertyGroup getPropertyGroupById (int id)

Added in revision 27

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID.

Parameters
id int unique identifier of the requested group.
Returns

public PropertyGroup getPropertyGroupByName (String name)

Added in revision 27

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID.

Parameters
name String name of the requested group.
Returns

public boolean isFullySupported ()

Added in revision 4

Tells if this property group is completely supported by the underling decoding hardware.

Returns
  • true if all contained property are supported by the underling decoding hardware.
    If this property group doesn't contain any property, this method returns false.

public boolean isSupported ()

Added in revision 1

Tells if this property group is supported by the underling decoding hardware.

Returns
  • true if at least one contained property is supported by the underling decoding hardware.
    If this property group doesn't contain any property, this method returns false.

public int load (PropertyGetter from)

Added in revision 1

Load the properties values contained by this group from the PropertyGetter.

Parameters
from The PropertyGetter called to synchronize the current values.
Returns
  • int SUCCESS in case of success, otherwise a possible error code, matching one of the ConfigException error constants.
Throws
ConfigException in case of error, when exceptions are enabled through the ErrorManager singleton.

public void setToDefault ()

Added in revision 27

Resets to the default value all the properties contained in the subtree. To make the change persistent the commit() must be called.

public int store (PropertyEditor to, boolean persist)

Added in revision 1

Store the properties values contained by this property into the PropertyEditor.

Parameters
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.
Returns
  • int SUCCESS in case of success, otherwise a possible error code, matching one of the ConfigException error constants.
Throws
ConfigException in case of error, when exceptions are enabled through the ErrorManager singleton.