com.atlassian.jira.issue.customfields.impl

Class CalculatedCFType<T,S>

java.lang.Object

com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,S>

com.atlassian.jira.issue.customfields.impl.CalculatedCFType<T,S>

Type Parameters:

T - Transport Object as defined in CustomFieldType

S - Single Object contained within the Transport Object as defined in CustomFieldType

All Implemented Interfaces:

CustomFieldType<T,S>

@PublicSpi
public abstract class CalculatedCFType<T,S>
extends AbstractCustomFieldType<T,S>

A CustomFieldType which is calculated rather than set. Transport Object is defined by subclass.

Note that this used to implement SortableCustomField, but it is now up to subclasses to opt-in to sortable if they really want it. This is mostly not recommended because of the poor performance of using that interface - see NaturallyOrderedCustomFieldSearcher and SortableCustomFieldSearcher for the preferred approach to sortable Custom Fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CalculatedCFType.Visitor<X>

Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

AbstractCustomFieldType.VisitorBase<X>

Field Summary

Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor and Description
CalculatedCFType()

Method Summary

Modifier and Type	Method and Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor)
int	compare(T o1, T o2, FieldConfig fieldConfig)
void	createValue(CustomField field, Issue issue, T value) Save the value for this Custom Field in a particular issue to the database.
String	getChangelogValue(CustomField field, T value) Returns a values to be stored in the change log, example is the id of the changed item.
List<FieldConfigItemType>	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
T	getDefaultValue(FieldConfig fieldConfig) Retrieves the Object representing the default CustomField value for the Custom Field.
Object	getStringValueFromCustomFieldParams(CustomFieldParams parameters) Return the String value object from the CustomFieldParams.
T	getValueFromCustomFieldParams(CustomFieldParams parameters) Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
Set<Long>	remove(CustomField field) Performs additional tasks when an entire CustomField of this type is being removed CustomField.remove().
void	setDefaultValue(FieldConfig fieldConfig, T value) Sets the default value for a Custom Field
void	updateValue(CustomField field, Issue issue, T value) Update the value for this Custom Field in a particular issue currently stored in the database.
void	validateFromParams(CustomFieldParams relevantParams, ErrorCollection errorCollectionToAddTo, FieldConfig config) Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values.

Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, getVelocityParameters, init, isRenderable, valuesEqual

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

getCloneOptionConfiguration, getCloneValue, getNonnullCustomFieldProvider, getNonNullCustomFieldProvider, getSingularObjectFromString, getStringFromSingularObject, getValueFromIssue, isUserInputRequiredForMove

Constructor Detail

CalculatedCFType

public CalculatedCFType()

Method Detail

remove

public Set<Long> remove(CustomField field)

Description copied from interface: CustomFieldType

Performs additional tasks when an entire CustomField of this type is being removed CustomField.remove(). This includes removal of values & options.

Parameters:

field - The custom field that is being removed, so any data stored for any issues for that field can be deleted.

Returns:

Set of issue ids that has been affected

validateFromParams

public void validateFromParams(CustomFieldParams relevantParams,
                               ErrorCollection errorCollectionToAddTo,
                               FieldConfig config)

Description copied from interface: CustomFieldType

Ensures that the CustomFieldParams of Strings is a valid representation of the Custom Field values. Any errors should be added to the ErrorCollection under the appropriate key as required.

Parameters:

relevantParams - parameter object of Strings

errorCollectionToAddTo - errorCollection to which any errors should be added (never null)

config - FieldConfig

createValue

public void createValue(CustomField field,
                        Issue issue,
                        @Nonnull
                        T value)

Description copied from interface: CustomFieldType

Save the value for this Custom Field in a particular issue to the database.

Parameters:

field - CustomField for which the value is being stored

issue - The Issue to be stored against.

value - Transport Object representing the value instance of the CustomField. Can not be null.

updateValue

public void updateValue(CustomField field,
                        Issue issue,
                        T value)

Description copied from interface: CustomFieldType

Update the value for this Custom Field in a particular issue currently stored in the database.

Parameters:

field - CustomField for which the value is being stored

issue - The Issue to be stored against.

value - Transport Object representing the value instance of the CustomField.

getDefaultValue

public T getDefaultValue(FieldConfig fieldConfig)

Description copied from interface: CustomFieldType

Retrieves the Object representing the default CustomField value for the Custom Field.

Parameters:

fieldConfig - CustomField for default value

Returns:

Transport Object of the Default Value

setDefaultValue

public void setDefaultValue(FieldConfig fieldConfig,
                            T value)

Description copied from interface: CustomFieldType

Sets the default value for a Custom Field

Parameters:

fieldConfig - CustomField for which the default is being stored

value - Transport Object representing the value instance of the CustomField

getChangelogValue

public String getChangelogValue(CustomField field,
                                T value)

Description copied from interface: CustomFieldType

Returns a values to be stored in the change log, example is the id of the changed item.

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log value.

getValueFromCustomFieldParams

public T getValueFromCustomFieldParams(CustomFieldParams parameters)
                                throws FieldValidationException

Description copied from interface: CustomFieldType

Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.

Parameters:

parameters - CustomFieldParams of String objects. Will contain one value for Singular field types.

Returns:

Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, T)

Throws:

FieldValidationException - if the String value fails to convert into Objects

See Also:

CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, Object), CustomFieldType.getValueFromIssue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue)

getStringValueFromCustomFieldParams

public Object getStringValueFromCustomFieldParams(CustomFieldParams parameters)

Description copied from interface: CustomFieldType

Return the String value object from the CustomFieldParams. The object may be a single String (e.g. TextCFType, List of Strings (e.g. MultiSelectCFType) or CustomFieldParams of Strings (e.g. CascadingSelectCFType). Among other things these values are passed to Velocity for rendering edit screens.

Parameters:

parameters - - CustomFieldParams containing String values

Returns:

String value object from the CustomFieldParams

compare

public int compare(@Nonnull
                   T o1,
                   @Nonnull
                   T o2,
                   FieldConfig fieldConfig)

getConfigurationItemTypes

@Nonnull
public List<FieldConfigItemType> getConfigurationItemTypes()

Description copied from interface: CustomFieldType

Returns a List of FieldConfigItemType objects. Can not be immutable. This opens up possibilities for configurable custom fields.

Specified by:

getConfigurationItemTypes in interface CustomFieldType<T,S>

Overrides:

getConfigurationItemTypes in class AbstractCustomFieldType<T,S>

Returns:

List of FieldConfigItemType

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractCustomFieldType<T,S>