Package com.atlassian.jira.issue.customfields.manager

Class CachedOptionsManager

java.lang.Object

com.atlassian.jira.issue.customfields.manager.DefaultOptionsManager

com.atlassian.jira.issue.customfields.manager.CachedOptionsManager

All Implemented Interfaces:

InitializingComponent, OptionsManager

public class CachedOptionsManager
extends DefaultOptionsManager
implements InitializingComponent

Cache for Options Manager. Not particularly neat More a problem with how the OptionsManager is used really

Field Summary

Fields inherited from class com.atlassian.jira.issue.customfields.manager.DefaultOptionsManager

ENTITY_CONFIG_ID, fieldConfigManager, ORDER_BY_LIST

Constructor Summary

Constructors

Constructor	Description
CachedOptionsManager(OfBizDelegator delegator, FieldConfigManager fieldConfigManager, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method	Description
void	afterInstantiation()	Called after all the beans are constructed and the ApplicationContext is fully populated.
Option	createOption(FieldConfig fieldConfig, Long parentOptionId, Long sequence, String value)	Create a new option for the given custom field config.
List<Option>	createOptions(FieldConfig config, Long parentOptionId, Long sequence, Iterable<String> options)	Bulk version of OptionsManager.createOption(FieldConfig, Long, Long, String) method
void	deleteOptionAndChildren(Option option)
void	disableOption(Option option)	Set an option to disabled.
void	enableOption(Option option)	Set an option to enabled.
Option	findByOptionId(Long optionId)
List<Option>	findByOptionValue(String value)	Finds all options with the given value.
List<Option>	findByParentId(Long parentOptionId)	Finds all options with the given parent option id.
List<Option>	getAllOptions()	Retreives all Option in the system.
Options	getOptions(FieldConfig fieldConfig)	Get options for this particular custom field type.
void	onClearCache(ClearCacheEvent event)
void	removeCustomFieldConfigOptions(FieldConfig fieldConfig)
void	removeCustomFieldOptions(CustomField customField)
void	setRootOptions(FieldConfig fieldConfig, Options options)
void	setValue(Option option, String value)
void	updateOptions(Collection<Option> options)	Update a set of options.

Methods inherited from class com.atlassian.jira.issue.customfields.manager.DefaultOptionsManager

getOptions

Methods inherited from class java.lang.Object

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

Constructor Details

CachedOptionsManager

public CachedOptionsManager(OfBizDelegator delegator,
 FieldConfigManager fieldConfigManager,
 com.atlassian.cache.CacheManager cacheManager)

Method Details

afterInstantiation

public void afterInstantiation()
                        throws Exception

Description copied from interface: InitializingComponent

Called after all the beans are constructed and the ApplicationContext is fully populated. Order of execution is order of bean creation, driven by InitializingComponentProcessor.

Specified by:

afterInstantiation in interface InitializingComponent

Throws:

Exception

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getAllOptions

public List<Option> getAllOptions()

Description copied from interface: OptionsManager

Retreives all Option in the system.

Specified by:

getAllOptions in interface OptionsManager

Overrides:

getAllOptions in class DefaultOptionsManager

Returns:

a list of all options in the system

findByOptionValue

public List<Option> findByOptionValue(String value)

Description copied from interface: OptionsManager

Finds all options with the given value. Returns and empty list if no options are found.

Specified by:

findByOptionValue in interface OptionsManager

Overrides:

findByOptionValue in class DefaultOptionsManager

Parameters:

value - the value of the options to find (case insensitive). Must not be null.

Returns:

the list of found options, empty if non found.

getOptions

public Options getOptions(FieldConfig fieldConfig)

Description copied from interface: OptionsManager

Get options for this particular custom field type. As a custom field may have multiple types of options (e.g. cascading drop-downs), the type can be used to signify this

Specified by:

getOptions in interface OptionsManager

Overrides:

getOptions in class DefaultOptionsManager

Parameters:

fieldConfig - For example, retrieved from CustomField.getRelevantConfig(com.atlassian.jira.issue.Issue)

Returns:

An option Object of Options

setRootOptions

public void setRootOptions(FieldConfig fieldConfig,
 Options options)

Specified by:

setRootOptions in interface OptionsManager

Overrides:

setRootOptions in class DefaultOptionsManager

removeCustomFieldOptions

public void removeCustomFieldOptions(CustomField customField)

Specified by:

removeCustomFieldOptions in interface OptionsManager

Overrides:

removeCustomFieldOptions in class DefaultOptionsManager

removeCustomFieldConfigOptions

public void removeCustomFieldConfigOptions(FieldConfig fieldConfig)

Specified by:

removeCustomFieldConfigOptions in interface OptionsManager

Overrides:

removeCustomFieldConfigOptions in class DefaultOptionsManager

updateOptions

public void updateOptions(Collection<Option> options)

Description copied from interface: OptionsManager

Update a set of options. After doing this, any existing Options objects may be stale, and should be re-fetched with OptionsManager.getOptions(com.atlassian.jira.issue.fields.config.FieldConfig).

Specified by:

updateOptions in interface OptionsManager

Overrides:

updateOptions in class DefaultOptionsManager

Parameters:

options - Usually an Options implementation.

createOption

public Option createOption(FieldConfig fieldConfig,
 Long parentOptionId,
 Long sequence,
 String value)

Description copied from interface: OptionsManager

Create a new option for the given custom field config.

Specified by:

createOption in interface OptionsManager

Overrides:

createOption in class DefaultOptionsManager

Parameters:

fieldConfig - The custom field config to create the option for

parentOptionId - The id of the parent option, or null if this is a root option

sequence - The sequence of the option (position on the list)

value - The value of the option

Returns:

The newly created option

createOptions

public List<Option> createOptions(FieldConfig config,
 Long parentOptionId,
 Long sequence,
 Iterable<String> options)

Description copied from interface: OptionsManager

Bulk version of OptionsManager.createOption(FieldConfig, Long, Long, String) method

Specified by:

createOptions in interface OptionsManager

Overrides:

createOptions in class DefaultOptionsManager

deleteOptionAndChildren

public void deleteOptionAndChildren(Option option)

Specified by:

deleteOptionAndChildren in interface OptionsManager

Overrides:

deleteOptionAndChildren in class DefaultOptionsManager

setValue

public void setValue(Option option,
 String value)

Specified by:

setValue in interface OptionsManager

Overrides:

setValue in class DefaultOptionsManager

disableOption

public void disableOption(Option option)

Description copied from interface: OptionsManager

Set an option to disabled. A disabled option will is not available to be assigned to this associated custom field, It remains valid historically and for searching with.

Specified by:

disableOption in interface OptionsManager

Overrides:

disableOption in class DefaultOptionsManager

Parameters:

option - The option to be disabled.

enableOption

public void enableOption(Option option)

Description copied from interface: OptionsManager

Set an option to enabled.

Specified by:

enableOption in interface OptionsManager

Overrides:

enableOption in class DefaultOptionsManager

Parameters:

option - The Option to enable.

findByOptionId

public Option findByOptionId(Long optionId)

Specified by:

findByOptionId in interface OptionsManager

Overrides:

findByOptionId in class DefaultOptionsManager

findByParentId

@Nonnull
public List<Option> findByParentId(Long parentOptionId)

Description copied from interface: OptionsManager

Finds all options with the given parent option id. Returns an empty list if no options are found.

Specified by:

findByParentId in interface OptionsManager

Overrides:

findByParentId in class DefaultOptionsManager

Parameters:

parentOptionId - the id of the parent option.

Returns:

the list of found options, empty if non found.