me.legrange.panstamp

Interface Parameter<T>

Type Parameters:

T - Type of parameter

public interface Parameter<T>

A parameter that can be set for a panStamp device.

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Parameter.Type Type of value sent and/or received by an endpoint.

Method Summary

Modifier and Type	Method and Description
T	getDefault() returns the default value of the parameter as defined in XML.
String	getName() Return the name of the parameter (as defined by XML)
String	getPattern() Return the verification pattern for this parameter.
Register	getRegister() Returns the register associated with this parameter.
Parameter.Type	getType() Return the type of the parameter.
T	getValue()
boolean	hasValue() Returns true if the parameter has a known value
void	setValue(T value) set the value of the parameter

Method Detail

getName

String getName()

Return the name of the parameter (as defined by XML)

Returns:

The name of the parameter

getType

Parameter.Type getType()

Return the type of the parameter.

Returns:

The type of the parameter

hasValue

boolean hasValue()

Returns true if the parameter has a known value

Returns:

True if a value is known.

getValue

T getValue()
    throws NetworkException

Throws:

NetworkException

getDefault

T getDefault()

returns the default value of the parameter as defined in XML.

Returns:

The default value.

setValue

void setValue(T value)
       throws NetworkException

set the value of the parameter

Parameters:

value - The value to set

Throws:

NetworkException - Thrown if there is a problem setting the parameter value.

getPattern

String getPattern()

Return the verification pattern for this parameter.

Returns:

The pattern regex.

getRegister

Register getRegister()

Returns the register associated with this parameter.

Returns:

The register