com.fatwire.cs.core.properties

Class Description

java.lang.Object

com.fatwire.cs.core.properties.Description

public final class Description
extends Object

This class defines a property that Content Server's property editor can read and describe.

Constructor Summary

Constructors

Constructor and Description
Description(String name, String description, String defaultValue, String category) Create a new Description

Method Summary

Modifier and Type	Method and Description
String	category() Get the category for this property
String	defaultValue() Get a default value for this property.
String	description() Get a text description of this property.
String	name() Get the name of this property

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description(String name,
                   String description,
                   String defaultValue,
                   String category)

Create a new Description

Parameters:

name - name of the property

description - description of the property

defaultValue - default value of this property

category - category of the property within whatever file defines it

Method Detail

category

public final String category()

Get the category for this property

Returns:

String identifier for the category of the property

name

public final String name()

Get the name of this property

Returns:

the name of the property

description

public final String description()

Get a text description of this property.

Returns:

the description of the property

defaultValue

public final String defaultValue()

Get a default value for this property.

Returns:

the default value of the property