de.hawhamburg.reachability.properties

Class PropertyDescription

java.lang.Object

de.hawhamburg.reachability.properties.PropertyDescription

public class PropertyDescription
extends java.lang.Object

Data object which holds the description of a property.

This data objects provides the description of a property which shall be used in common with interface implementation and the configuration management user interface.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	displayGroup The groups name as String which subsumes this property with others.
private java.lang.String	displayName The properties name as String which shall be displayed within a user interface as name for this property.
private DisplayType	displayType The DisplayType of this property.
private java.util.Map<java.lang.String,java.lang.String>	possibleValues The possible values as Map of String (value) to String (display name).

Constructor Summary

Constructors

Constructor and Description
PropertyDescription() Create empty property description.
PropertyDescription(java.lang.String dspName, DisplayType dspType, java.lang.String dspGroup, java.util.Map<java.lang.String,java.lang.String> validValues) Creates a proper property description.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPossibleValue(java.lang.String value, java.lang.String dspValue) Adds an entry to the list of possible values.
java.lang.String	getDisplayGroup() Returns the display group as String.
java.lang.String	getDisplayName() Returns the display name as String.
DisplayType	getDisplayType() Returns the display type as DisplayType.
java.util.Map<java.lang.String,java.lang.String>	getPossibleValue() Returns the list of possible values as Map of String (value) to String (display name).
void	setDisplayGroup(java.lang.String dspGroup) Sets/updates the display group.
void	setDisplayName(java.lang.String dspName) Sets/updates the display name.
void	setDisplayType(DisplayType dspType) Sets/updates the display type.
void	setPossibleValues(java.util.Map<java.lang.String,java.lang.String> validValues) Sets/updates the list of possible values.

Methods inherited from class java.lang.Object

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

Field Detail

displayName

private java.lang.String displayName

The properties name as String which shall be displayed within a user interface as name for this property.

displayType

private DisplayType displayType

The DisplayType of this property.

displayGroup

private java.lang.String displayGroup

The groups name as String which subsumes this property with others.

possibleValues

private java.util.Map<java.lang.String,java.lang.String> possibleValues

The possible values as Map of String (value) to String (display name).

Constructor Detail

PropertyDescription

public PropertyDescription()

Create empty property description.

PropertyDescription

public PropertyDescription(java.lang.String dspName,
                   DisplayType dspType,
                   java.lang.String dspGroup,
                   java.util.Map<java.lang.String,java.lang.String> validValues)

Creates a proper property description.

Parameters:

dspName - The properties display name as String.

dspType - The DisplayType of this property.

dspGroup - The groups display name as String in which this property is included.

validValues - A list of valid values as Map of String (value) to String (display name).

Method Detail

setDisplayName

public final void setDisplayName(java.lang.String dspName)

Sets/updates the display name.

Parameters:

dspName - The new value for the display name as String.

setDisplayType

public final void setDisplayType(DisplayType dspType)

Sets/updates the display type.

Parameters:

dspType - The new value for the display type as DisplayType.

setDisplayGroup

public final void setDisplayGroup(java.lang.String dspGroup)

Sets/updates the display group.

Parameters:

dspGroup - The new value for the display group as String.

setPossibleValues

public final void setPossibleValues(java.util.Map<java.lang.String,java.lang.String> validValues)

Sets/updates the list of possible values.

Parameters:

validValues - The new value for the list of possible values as Map of String (value) to String (display name).

addPossibleValue

public final void addPossibleValue(java.lang.String value,
                    java.lang.String dspValue)

Adds an entry to the list of possible values.

Parameters:

value - The value as String.

dspValue - The display name of this value as String which shall be displayed to the user.

getDisplayName

public final java.lang.String getDisplayName()

Returns the display name as String.

Returns:

The display name as String.

getDisplayType

public final DisplayType getDisplayType()

Returns the display type as DisplayType.

Returns:

The display type as DisplayType.

getDisplayGroup

public final java.lang.String getDisplayGroup()

Returns the display group as String.

Returns:

The display group as String.

getPossibleValue

public final java.util.Map<java.lang.String,java.lang.String> getPossibleValue()

Returns the list of possible values as Map of String (value) to String (display name).

Returns:

The list of possible values as Map of String (value) to String (display name).