public class

ObjectConfigurationImpl

extends Object
implements ObjectConfiguration
java.lang.Object
   ↳ com.atlassian.configurable.ObjectConfigurationImpl

Summary

Public Constructors
ObjectConfigurationImpl(Map<String, ObjectConfigurationProperty> configProperties, ObjectDescriptor od)
Creates a new ObjectConfigurationImpl object.
Public Methods
boolean allFieldsHidden()
Determines if there are any non-hidden fields.
String getDescription(Map params)
The Description of this instance of an Object Configuration
String[] getEnabledFieldKeys()
The enabled property keys for this configuration.
String getFieldDefault(String key)
Retrieves the default value for property with specified key
String getFieldDescription(String key)
Retrieves the description of a property with the specified key
String[] getFieldKeys()
All the property keys for this configuration
String getFieldName(String key)
Retrieves the name of a property with the specified key
int getFieldType(String key)
Retrieves the type of the property with the specified key
Map getFieldValues(String key)
Retrieves a map of available values for property with the specified key.
Map getFieldValuesHtmlEncoded(String key)
Retrieves a map of available values for property with the specified key.
void init(Map params)
Initialises the object with some parameters
boolean isEnabled(String key)
Is a particular property enabled at the moment - may be a runtime check.
boolean isI18NValues(String key)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.configurable.ObjectConfiguration

Public Constructors

public ObjectConfigurationImpl (Map<String, ObjectConfigurationProperty> configProperties, ObjectDescriptor od)

Creates a new ObjectConfigurationImpl object.

Parameters
configProperties A Map of properties that can be configured for this object e.g. name, description.
od A Class the retrieves the Description of this object based the currently configured properties.

Public Methods

public boolean allFieldsHidden ()

Determines if there are any non-hidden fields.

Returns
  • true if there are no fields or all fields are hidden

public String getDescription (Map params)

The Description of this instance of an Object Configuration

Parameters
params Params used to derive
Returns
  • Description

public String[] getEnabledFieldKeys ()

The enabled property keys for this configuration.

Returns
  • Property keys

public String getFieldDefault (String key)

Retrieves the default value for property with specified key

Parameters
key Key of the property
Returns
  • Default value of the specified property
Throws
ObjectConfigurationException

public String getFieldDescription (String key)

Retrieves the description of a property with the specified key

Parameters
key Key of the property
Returns
  • Description of the specified property
Throws
ObjectConfigurationException

public String[] getFieldKeys ()

All the property keys for this configuration

Returns
  • Property keys

public String getFieldName (String key)

Retrieves the name of a property with the specified key

Parameters
key Key of the property
Returns
  • Name of the specified property
Throws
ObjectConfigurationException

public int getFieldType (String key)

Retrieves the type of the property with the specified key

Parameters
key Key of the property
Returns
  • Type of the specified property
Throws
ObjectConfigurationException

public Map getFieldValues (String key)

Retrieves a map of available values for property with the specified key. e.g select list values

Parameters
key Key of the property
Returns
  • List valid name/value pairs for the specified property
Throws
ObjectConfigurationException

public Map getFieldValuesHtmlEncoded (String key)

Retrieves a map of available values for property with the specified key. e.g select list values. However, keys and values are html encoded in the returned map.

Returns
  • List valid name/value pairs for the specified property - html encoded
Throws
ObjectConfigurationException

public void init (Map params)

Initialises the object with some parameters

Parameters
params Map of initialisation params

public boolean isEnabled (String key)

Is a particular property enabled at the moment - may be a runtime check.

Parameters
key the property's key.
Returns
  • true if the property is enabled in the current context

public boolean isI18NValues (String key)