public class

ObjectConfigurationPropertyImpl

extends Object
implements ObjectConfigurationProperty
java.lang.Object
   ↳ com.atlassian.configurable.ObjectConfigurationPropertyImpl
Known Direct Subclasses

Class Overview

This interface is a property of an Object Configuration and contains a name, description, default value and the type (ObjectConfigurationTypes) of this property. It can also contain a list of values if the type has values specified for it e.g. select list.

Summary

Public Methods
void clear()
Object Configuration Properties are immutable so this function throws an exception
boolean containsKey(Object key)
Does this property have a choice with key of the specified value
boolean containsValue(Object value)
Does this property have a choice with value of the specified value
Set entrySet()
Entry set of the choices for this property
Object get(Object key)
Returns the value of the choice that matches key
String getCascadeFrom()
String getDefault()
Retrieves the default value of this Property e.g.
String getDescription()
Retrieves the description of this Property e.g.
String getName()
Retrieves the name of this Property e.g.
int getType()
Retrieves the type of the Property e.g.
void init(Map userParams)
This is a list of user parameters that may be required to generate a list of values and/or a description for this Property.
boolean isEmpty()
Does this property have a number of possible choices
boolean isEnabled()
Whether the property is enabled in the current context.
boolean isI18nValues()
Set keySet()
Returns a set of the key for the choices for this property
Object put(Object key, Object value)
Object Configuration Properties are immutable so this function throws an exception
void putAll(Map t)
Object Configuration Properties are immutable so this function throws an exception
Object remove(Object key)
Object Configuration Properties are immutable so this function throws an exception
void setCascadeFrom(String cascadeFrom)
void setI18nValues(boolean i18nValues)
int size()
If this Property has a list of choices e.g.
Collection values()
Returns all the values for the choices of this property
Protected Methods
Map getInternalValues(Map userParams)
Returns the map of values stored internally for the choices of this property.
Map getMutableInternalValues()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.configurable.ObjectConfigurationProperty
From interface java.util.Map

Public Methods

public void clear ()

Object Configuration Properties are immutable so this function throws an exception

public boolean containsKey (Object key)

Does this property have a choice with key of the specified value

Parameters
key Does this Property have a choice with key, key
Returns
  • Has Key

public boolean containsValue (Object value)

Does this property have a choice with value of the specified value

Parameters
value Does this Property have a choice with value, value
Returns
  • Has Value

public Set entrySet ()

Entry set of the choices for this property

Returns
  • Entry Set

public Object get (Object key)

Returns the value of the choice that matches key

Parameters
key Key look for
Returns
  • value for key, key

public String getCascadeFrom ()

public String getDefault ()

Retrieves the default value of this Property e.g. Sydney

Returns
  • Default value of Property

public String getDescription ()

Retrieves the description of this Property e.g. Please enter you current location

Returns
  • Description of the Property

public String getName ()

Retrieves the name of this Property e.g. City

Returns
  • Name of this Property

public int getType ()

Retrieves the type of the Property e.g. Text

Returns

public void init (Map userParams)

This is a list of user parameters that may be required to generate a list of values and/or a description for this Property. e.g. a User may be required to generate a list of values they can see but other users can not.

Parameters
userParams Parameters used to generate a list of values and/or a description

public boolean isEmpty ()

Does this property have a number of possible choices

Returns
  • Does this property have a number of possible values

public boolean isEnabled ()

Whether the property is enabled in the current context. It is up to the implementation to divine the context.

Returns
  • true only if the property is enabled.

public boolean isI18nValues ()

public Set keySet ()

Returns a set of the key for the choices for this property

Returns
  • Set of keys

public Object put (Object key, Object value)

Object Configuration Properties are immutable so this function throws an exception

public void putAll (Map t)

Object Configuration Properties are immutable so this function throws an exception

public Object remove (Object key)

Object Configuration Properties are immutable so this function throws an exception

public void setCascadeFrom (String cascadeFrom)

public void setI18nValues (boolean i18nValues)

public int size ()

If this Property has a list of choices e.g. a select list then this function returns how many there are. If there are no choices it returns 0

Returns
  • Number of choices for this properties value

public Collection values ()

Returns all the values for the choices of this property

Returns
  • Collection of values

Protected Methods

protected Map getInternalValues (Map userParams)

Returns the map of values stored internally for the choices of this property.

Parameters
userParams Not used in this implementation.
Returns
  • Map of choices

protected Map getMutableInternalValues ()

Returns
  • the map of values stored internally for the choices of this property as a mutable Map.