com.datalogic.device.configuration

Class Property<T>

java.lang.Object

com.datalogic.device.configuration.Property<T>

Direct Known Subclasses:

BooleanProperty, CharacterProperty, EnumProperty, NumericProperty, TextProperty

public abstract class Property<T>
extends java.lang.Object

Property is the abstract class that represents a generic Property of type T.

Constructor Summary

Constructors

Constructor and Description
Property(int id) Constructor of Property.

Method Summary

Modifier and Type	Method and Description
static Property	findPropertybyId(java.util.ArrayList<Property> list, int id) Deprecated. no more to be used
T	get() Gets the current value of the Property.
int	getId() Gets the integer value of the unique identifier PropertyID of the property.
java.lang.String	getName() Gets the name of the unique identifier PropertyID of the property.
PropertyType	getType() Gets the type of the Property.
boolean	isSupported() Returns whether a Property is supported or not.
int	load(PropertyGetter from) Deprecated. no more to be used
static int	loadlist(PropertyGetter from, java.util.ArrayList list) Deprecated. no more to be used
int	set(T value) Sets the value of the property.
int	store(PropertyEditor to) Deprecated. no more to be used
static int	storelist(PropertyEditor to, java.util.ArrayList list) Deprecated. no more to be used

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(int id)

Constructor of Property.

Parameters:

id - int a corresponding numeric ID.

Method Detail

get

public T get()

Gets the current value of the Property.

Returns:

T The current value if the property is supported, null if the property is not supported.

Throws:

ConfigException - when the property is not supported, when exceptions are enabled through the ErrorManager singleton.

set

public int set(T value)

Sets the value of the property. To apply the value of the property to the device and make it persistent the method ConfigurationManager.commit() of ConfigurationManager must be called.

Parameters:

value - The value to be set.

Returns:

int ConfigException.SUCCESS in case of success otherwise a possible error code, matching one of the ConfigException error constants.

Throws:

ConfigException - when the property is not supported, when exceptions are enabled through the ErrorManager singleton.

getType

public PropertyType getType()

Gets the type of the Property.

Returns:

T PropertyType

getName

public java.lang.String getName()

Gets the name of the unique identifier PropertyID of the property.

Returns:

String

isSupported

public boolean isSupported()

Returns whether a Property is supported or not.

Returns:

boolean value representing whether the Property is supported or not.

getId

public int getId()

Gets the integer value of the unique identifier PropertyID of the property.

Returns:

int The PropertyID, as a number.

load

@Deprecated
public int load(PropertyGetter from)

Deprecated. no more to be used

Loads the property with the current set values, through a PropertyGetter.

Parameters:

from - The PropertyGetter called to synchronize the current values.

Returns:

int ConfigException.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.

store

@Deprecated
public int store(PropertyEditor to)

Deprecated. no more to be used

Stores the Property value, applying them.

Parameters:

to - The PropertyEditor in charge of applying the desired values.

Returns:

int ConfigException.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.

findPropertybyId

@Deprecated
public static Property findPropertybyId(java.util.ArrayList<Property> list,
                                                    int id)

Deprecated. no more to be used

Finds the corresponding Property matching the passed ID, in a list of Properties.

Parameters:

list - The ArrayList containing all the Properties.

id - The int representing the ID that should be found.

Returns:

Property corresponding to the passed ID, null in case of error.

storelist

@Deprecated
public static int storelist(PropertyEditor to,
                                        java.util.ArrayList list)

Deprecated. no more to be used

Stores and applies all the Properties and their current associated values.

Parameters:

to - The PropertyEditor used to store all the values.

list - The ArrayList containing the Properties.

Returns:

int ConfigException.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.

loadlist

@Deprecated
public static int loadlist(PropertyGetter from,
                                       java.util.ArrayList list)

Deprecated. no more to be used

Loads and sync the current set values into all the Properties contained in the passed list.

Parameters:

from - The PropertyGetter used to sync all the active values associated to the Properties.

list - The ArrayList containing the Properties to be loaded.

Returns:

int ConfigException.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.