public class

StringObjectDescription

extends Object
implements ObjectDescriptor
java.lang.Object
   ↳ com.atlassian.configurable.StringObjectDescription

Class Overview

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

Summary

Public Constructors
StringObjectDescription(String description)
Creates a new StringObjectDescription object.
Public Methods
String getDescription(Map properties, Map values)
Returns the description used when creating the object.
Map validateProperties(Map values)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.configurable.ObjectDescriptor

Public Constructors

public StringObjectDescription (String description)

Creates a new StringObjectDescription object.

Parameters
description Description to use when called by the owning ObjectConfiguration

Public Methods

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

Returns
  • Description when object was created.

public Map validateProperties (Map values)