com.whizzosoftware.hobson.api.property

Class TypedProperty

java.lang.Object

com.whizzosoftware.hobson.api.property.TypedProperty

All Implemented Interfaces:

java.io.Serializable

public class TypedProperty
extends java.lang.Object
implements java.io.Serializable

A property that specifies a type (such as STRING, NUMBER, etc).

Author:

Dan Noguerol

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypedProperty.Builder
static class	TypedProperty.Type

Method Summary

Modifier and Type	Method and Description
TypedProperty	addConstraint(PropertyConstraintType type, java.lang.Object argument)
boolean	evaluateConstraints(java.util.Collection<java.lang.String> publishedVariableNames) Evaluates whether all defined constraints are met.
java.util.Collection<TypedPropertyConstraint>	getConstraints()
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.String>	getEnumeration()
java.lang.String	getId()
java.lang.String	getName()
TypedProperty.Type	getType()
boolean	hasConstraintValue(PropertyConstraintType type, java.lang.Object value)
boolean	hasConstraintValues()
boolean	hasEnumeration()

Methods inherited from class java.lang.Object

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

Method Detail

getId

public java.lang.String getId()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getType

public TypedProperty.Type getType()

getEnumeration

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

getConstraints

public java.util.Collection<TypedPropertyConstraint> getConstraints()

addConstraint

public TypedProperty addConstraint(PropertyConstraintType type,
                                   java.lang.Object argument)

hasConstraintValues

public boolean hasConstraintValues()

hasConstraintValue

public boolean hasConstraintValue(PropertyConstraintType type,
                                  java.lang.Object value)

hasEnumeration

public boolean hasEnumeration()

evaluateConstraints

public boolean evaluateConstraints(java.util.Collection<java.lang.String> publishedVariableNames)

Evaluates whether all defined constraints are met.

Parameters:

publishedVariableNames - a list of all published variable names

Returns:

a boolean