org.umber.catalan.process.workers
Class OptionalPropertyInfo

java.lang.Object
  extended byorg.umber.catalan.process.workers.PropertyInfo
      extended byorg.umber.catalan.process.workers.OptionalPropertyInfo

public class OptionalPropertyInfo
extends PropertyInfo

PropertyInfo with an additional default field.

Author:
jsheets

Constructor Summary
OptionalPropertyInfo(java.lang.String name, java.lang.String description, java.lang.Object defaultValue)
          Creates a new instance of OptionalPropertyInfo.
OptionalPropertyInfo(java.lang.String name, java.lang.String description, java.lang.Object defaultValue, java.lang.Class[] legalTypes)
          Creates a new instance of OptionalPropertyInfo.
 
Method Summary
 java.lang.Object getDefault()
          Retrieves the default value of this property.
 
Methods inherited from class org.umber.catalan.process.workers.PropertyInfo
getDescription, getLegalTypes, getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionalPropertyInfo

public OptionalPropertyInfo(java.lang.String name,
                            java.lang.String description,
                            java.lang.Object defaultValue)
Creates a new instance of OptionalPropertyInfo. The name and default value parameters cannot be null.

Parameters:
name - property name
description - property description
defaultValue - default property value

OptionalPropertyInfo

public OptionalPropertyInfo(java.lang.String name,
                            java.lang.String description,
                            java.lang.Object defaultValue,
                            java.lang.Class[] legalTypes)
Creates a new instance of OptionalPropertyInfo. The name and default value parameters cannot be null.

Parameters:
name - property name
description - property description
defaultValue - default property value
legalTypes - object types this property is allowed to have
Method Detail

getDefault

public final java.lang.Object getDefault()
Retrieves the default value of this property.

Returns:
default property value