ValuesGeneratorObjectConfigurationProperty

extends ObjectConfigurationPropertyImpl

java.lang.Object
↳	com.atlassian.configurable.ObjectConfigurationPropertyImpl
	↳	com.atlassian.configurable.ValuesGeneratorObjectConfigurationProperty

Class Overview

Represents a property which gets its values derived from a ValuesGenerator implementation.

Summary

Public Constructors
	ValuesGeneratorObjectConfigurationProperty(String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass) Creates a new ValuesGeneratorObjectConfigurationProperty object.
	ValuesGeneratorObjectConfigurationProperty(String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass, ClassLoader classLoader) Creates a new ValuesGeneratorObjectConfigurationProperty object.

Protected Methods
Map	getInternalValues(Map userParams) Overides method in super class that uses a map stored in the object to retrieve choices.

[Expand]

Inherited Methods

From class com.atlassian.configurable.ObjectConfigurationPropertyImpl

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.
Map	getInternalValues(Map userParams) Returns the map of values stored internally for the choices of this property.
Map	getMutableInternalValues()
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

From class java.lang.Object

From interface com.atlassian.configurable.ObjectConfigurationProperty

String	getCascadeFrom()
String	getDefault() Retreives 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 params) Initialises the object so it can retrieve values dependant on the parameters in the Map
boolean	isEnabled() Whether the property is enabled in the current context.
boolean	isI18nValues()
void	setCascadeFrom(String cascadeFrom)
void	setI18nValues(boolean i18nValues)

From interface java.util.Map

void	clear()
boolean	containsKey(Object arg0)
boolean	containsValue(Object arg0)
Set<Entry<K, V>>	entrySet()
boolean	equals(Object arg0)
V	get(Object arg0)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
V	put(K arg0, V arg1)
void	putAll(Map<? extends K, ? extends V> arg0)
V	remove(Object arg0)
int	size()
Collection<V>	values()

Public Constructors

public ValuesGeneratorObjectConfigurationProperty (String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass)

Creates a new ValuesGeneratorObjectConfigurationProperty object.

Parameters

name	Property name
description	Property description
defaultValue	Default value
type	Field type, e.g. string, long ....
valueGeneratorClass	Instance of ValuesGenerator used to retrieve a list of available choices

public ValuesGeneratorObjectConfigurationProperty (String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass, ClassLoader classLoader)

Creates a new ValuesGeneratorObjectConfigurationProperty object.

Parameters

name	Property name
description	Property description
defaultValue	Default value
type	Field type, e.g. string, long ....
valueGeneratorClass	Instance of ValuesGenerator used to retrieve a list of available choices
classLoader	ClassLoader used to load the valueGeneratorClass

Protected Methods

protected Map getInternalValues (Map userParams)

Overides method in super class that uses a map stored in the object to retrieve choices. This function uses a ValuesGenerator class to retrieve the values.

Parameters

userParams	used to retrieve a cut down list of choices from the `ValuesGenerator` class

Returns

Map of choices dependant on this users parameters. If null is returned from the ValuesGenerator an empty list is returned, which is consistent with the behaviour of ObjectConfigurationPropertyImpl

Interfaces

Classes

Exceptions

ValuesGeneratorObjectConfigurationProperty

Class Overview

Summary

Public Constructors

public ValuesGeneratorObjectConfigurationProperty (String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass)

Parameters

public ValuesGeneratorObjectConfigurationProperty (String name, String description, String defaultValue, int type, String valueGeneratorClass, String enabledConditionClass, ClassLoader classLoader)

Parameters

Protected Methods

protected Map getInternalValues (Map userParams)

Parameters

Returns