org.writersforge.catalan.process.workers
Class PropertyInfo

java.lang.Object
  org.writersforge.catalan.process.workers.PropertyInfo

Direct Known Subclasses:

OptionalPropertyInfo

public class PropertyInfo

extends java.lang.Object

Metadata for a command property.

Author:

jsheets

Constructor Summary

PropertyInfo(java.lang.String name, java.lang.String description)
Creates a new instance of PropertyInfo.

PropertyInfo(java.lang.String name, java.lang.String description, java.lang.Class[] legalTypes)
Creates a new instance of PropertyInfo with a type restriction.

Method Summary

java.lang.String	getDescription() Retrieves the user-friendly description for this property.
java.lang.Class[]	getLegalTypes() Retrieves the legal types that this property is allowed to support.
java.lang.String	getName() Retrieves the name of the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyInfo

public PropertyInfo(java.lang.String name,
                    java.lang.String description)

Creates a new instance of PropertyInfo. The name property cannot be null.

Parameters:

name - property name

description - property description

PropertyInfo

public PropertyInfo(java.lang.String name,
                    java.lang.String description,
                    java.lang.Class[] legalTypes)

Creates a new instance of PropertyInfo with a type restriction. The name property cannot be null.

Parameters:

name - property name

description - property description

legalTypes - object types this property is allowed to have

Method Detail

getName

public final java.lang.String getName()

Retrieves the name of the command.

Returns:

command name

getDescription

public final java.lang.String getDescription()

Retrieves the user-friendly description for this property.

Returns:

property description

getLegalTypes

public final java.lang.Class[] getLegalTypes()

Retrieves the legal types that this property is allowed to support.

Returns:

legal property types