com.atlassian.configurable

Class StringObjectDescription

java.lang.Object

com.atlassian.configurable.StringObjectDescription

All Implemented Interfaces:

ObjectDescriptor

public class StringObjectDescription
extends Object
implements ObjectDescriptor

Simple implementation of ObjectDescriptor that simply returns the description that was passed in when the object was created.

Constructor Summary

Constructors

Constructor and Description
StringObjectDescription(String description) Creates a new StringObjectDescription object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(Map properties, Map values) Returns the description used when creating the object.
Map	validateProperties(Map values)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringObjectDescription

public StringObjectDescription(String description)

Creates a new StringObjectDescription object.

Parameters:

description - Description to use when called by the owning ObjectConfiguration

Method Detail

getDescription

public String getDescription(Map properties,
                    Map values)

Returns the description used when creating the object. The properties and values are not used in this class but are there to allow more complicated descriptions

Specified by:

getDescription in interface ObjectDescriptor

Returns:

Description when object was created.

validateProperties

public Map validateProperties(Map values)

Specified by:

validateProperties in interface ObjectDescriptor