com.atlassian.jira.issue.customfields.impl

Class VersionCFType

java.lang.Object

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

com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Version>

com.atlassian.jira.issue.customfields.impl.VersionCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<Collection<Version>,Version>, RequiresProjectSelectedMarker, SortableCustomField, ExportableCustomFieldType, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class VersionCFType
extends AbstractMultiCFType<Version>
implements RequiresProjectSelectedMarker, SortableCustomField, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations, ExportableCustomFieldType

Custom Field Type to select multiple Versions.

Transport Object Type

Collection of Versions

Singular Object Type

Version

Database Storage Type

Long of the Version's id

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionCFType.VersionOrder An enum representing orders can be choosed to affect the order of versions group displayed on version picker custom field
static interface	VersionCFType.Visitor<X>

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

AbstractCustomFieldType.VisitorBase<X>

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPLE_VERSION_TYPE
static String	SINGLE_VERSION_TYPE

Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType

customFieldValuePersister

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

DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor and Description
VersionCFType(PermissionManager permissionManager, JiraAuthenticationContext jiraAuthenticationContext, VersionManager versionManager, CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, VersionHelperBean versionHelperBean, JiraBaseUrls jiraBaseUrls)

Method Summary

Modifier and Type	Method and Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor)
String	availableForBulkEdit(BulkEditBean bulkEditBean) Allow the custom field type perform a specific check as to its availability for bulk editing.
int	compare(Object customFieldObjectValue1, Object customFieldObjectValue2, FieldConfig fieldConfig) Compares the two custom field objects.
protected Version	convertDbValueToType(Object input) Converts a given db value to Single form of Transport Object
protected Object	convertTypeToDbValue(Version value) Converts a given underlying type to its db storage value.
String	getChangelogString(CustomField field, Collection<Version> versions) Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.
List<FieldConfigItemType>	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
protected PersistenceFieldType	getDatabaseType() Type of database field needed to store this field.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
JsonData	getJsonDefaultValue(IssueContext issueCtx, CustomField field) Return The default data for this system field.
FieldJsonRepresentation	getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Return a JsonData representation of the field value
JsonType	getJsonSchema(CustomField customField) Return a description of the shape of this field when represented as JSON.
NonNullCustomFieldProvider	getNonNullCustomFieldProvider() Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
FieldExportParts	getRepresentationFromIssue(Issue issue, CustomFieldExportContext context) Generates a multi column representation for all the versions in this issue.
RestFieldOperationsHandler	getRestFieldOperation(CustomField field) Returns the RestFieldOperationsHandler for this field.
Version	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(Version version) Returns the String representation of a single value within the CustomFieldType.
Object	getStringValueFromCustomFieldParams(CustomFieldParams parameters) Return the String value object from the CustomFieldParams.
protected Comparator<Version>	getTypeComparator() Returns a comparator for underlying type of this custom field.
Collection<Version>	getValueFromCustomFieldParams(CustomFieldParams parameters) Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
Map<String,Object>	getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem) The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).
boolean	isMultiple()
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.AbstractMultiCFType

convertDbObjectToTypes, convertTypesToDbObjects, createValue, getChangelogValue, getDefaultValue, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, updateValue

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

assertObjectImplementsType, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, 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

areAllRequiredParametersPresent, getCloneOptionConfiguration, getCloneValue, getNonnullCustomFieldProvider, isUserInputRequiredForMove

Field Detail

SINGLE_VERSION_TYPE

public static final String SINGLE_VERSION_TYPE

See Also:

Constant Field Values

MULTIPLE_VERSION_TYPE

public static final String MULTIPLE_VERSION_TYPE

See Also:

Constant Field Values

Constructor Detail

VersionCFType

public VersionCFType(PermissionManager permissionManager,
                     JiraAuthenticationContext jiraAuthenticationContext,
                     VersionManager versionManager,
                     CustomFieldValuePersister customFieldValuePersister,
                     GenericConfigManager genericConfigManager,
                     VersionHelperBean versionHelperBean,
                     JiraBaseUrls jiraBaseUrls)

Method Detail

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.

Specified by:

validateFromParams in interface CustomFieldType<Collection<Version>,Version>

Parameters:

relevantParams - parameter object of Strings

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

config - FieldConfig

getValueFromCustomFieldParams

public Collection<Version> getValueFromCustomFieldParams(CustomFieldParams parameters)
                                                  throws FieldValidationException

Description copied from interface: CustomFieldType

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

Specified by:

getValueFromCustomFieldParams in interface CustomFieldType<Collection<Version>,Version>

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.

Specified by:

getStringValueFromCustomFieldParams in interface CustomFieldType<Collection<Version>,Version>

Parameters:

parameters - - CustomFieldParams containing String values

Returns:

String value object from the CustomFieldParams

getChangelogString

public String getChangelogString(CustomField field,
                                 Collection<Version> versions)

Description copied from interface: CustomFieldType

Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.

Specified by:

getChangelogString in interface CustomFieldType<Collection<Version>,Version>

Overrides:

getChangelogString in class AbstractCustomFieldType<Collection<Version>,Version>

Parameters:

field - CustomField that the value belongs to

versions - Transport Object representing the value instance of the CustomField

Returns:

Change log string.

getStringFromSingularObject

public String getStringFromSingularObject(Version version)

Description copied from interface: CustomFieldType

Returns the String representation of a single value within the CustomFieldType. This is the value that is passed to the presentation tier for editing. For single CustomFieldTypes the Singular Object is the same as a Transport Object. However, for multi-dimensional CustomFieldTypes, the Singular Object is the Object contained within the Collection or Map

Specified by:

getStringFromSingularObject in interface CustomFieldType<Collection<Version>,Version>

Parameters:

version - the object

Returns:

String representation of the Object

getSingularObjectFromString

public Version getSingularObjectFromString(String string)
                                    throws FieldValidationException

Description copied from interface: CustomFieldType

Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.

Specified by:

getSingularObjectFromString in interface CustomFieldType<Collection<Version>,Version>

Parameters:

string - the String

Returns:

singularObject instance

Throws:

FieldValidationException - if the string is an invalid representation of the Object.

compare

public int compare(@Nonnull
                   Object customFieldObjectValue1,
                   @Nonnull
                   Object customFieldObjectValue2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField

Parameters:

customFieldObjectValue1 - Never null

customFieldObjectValue2 - Never null

Returns:

0, 1 or -1

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<Collection<Version>,Version>

Overrides:

getConfigurationItemTypes in class AbstractCustomFieldType<Collection<Version>,Version>

Returns:

List of FieldConfigItemType

availableForBulkEdit

public String availableForBulkEdit(BulkEditBean bulkEditBean)

Description copied from interface: CustomFieldType

Allow the custom field type perform a specific check as to its availability for bulk editing.

Specified by:

availableForBulkEdit in interface CustomFieldType<Collection<Version>,Version>

Overrides:

availableForBulkEdit in class AbstractCustomFieldType<Collection<Version>,Version>

Parameters:

bulkEditBean - BulkEditBean

Returns:

null if available for bulk edit or appropriate unavailable message

getVelocityParameters

@Nonnull
public Map<String,Object> getVelocityParameters(Issue issue,
                                                         CustomField field,
                                                         FieldLayoutItem fieldLayoutItem)

Description copied from interface: CustomFieldType

The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

The values are added to the context for all velocity views (edit, search, view, xml)

Specified by:

getVelocityParameters in interface CustomFieldType<Collection<Version>,Version>

Overrides:

getVelocityParameters in class AbstractCustomFieldType<Collection<Version>,Version>

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

field - CustomField

fieldLayoutItem - FieldLayoutItem

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()

Description copied from interface: ProjectImportableCustomField

Returns the object that will perform the actual project import functions for the custom field type.

Specified by:

getProjectImporter in interface ProjectImportableCustomField

Returns:

the object that will perform the actual project import functions for the custom field type.

isMultiple

public boolean isMultiple()

getTypeComparator

protected Comparator<Version> getTypeComparator()

Description copied from class: AbstractMultiCFType

Returns a comparator for underlying type of this custom field. Used e.g. for sorting values retrieved from the Database

Specified by:

getTypeComparator in class AbstractMultiCFType<Version>

Returns:

a comparator, null if can't be compared without extra context

convertTypeToDbValue

protected Object convertTypeToDbValue(Version value)

Description copied from class: AbstractMultiCFType

Converts a given underlying type to its db storage value. Must be compatable with PersistenceFieldType returned by AbstractMultiCFType.getDatabaseType()

Specified by:

convertTypeToDbValue in class AbstractMultiCFType<Version>

Parameters:

value - Single form of Transport Object

Returns:

database representation of given Transport Object.

convertDbValueToType

protected Version convertDbValueToType(Object input)

Description copied from class: AbstractMultiCFType

Converts a given db value to Single form of Transport Object

Specified by:

convertDbValueToType in class AbstractMultiCFType<Version>

Parameters:

input - db representation as returned by AbstractMultiCFType.convertTypeToDbValue(Object)

Returns:

Single form of Transport Object

getDatabaseType

@Nonnull
protected PersistenceFieldType getDatabaseType()

Description copied from class: AbstractMultiCFType

Type of database field needed to store this field.

Specified by:

getDatabaseType in class AbstractMultiCFType<Version>

Returns:

One of the predefined PersistenceFieldType types.

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractMultiCFType<Version>

getRestFieldOperation

public RestFieldOperationsHandler getRestFieldOperation(CustomField field)

Description copied from interface: RestCustomFieldTypeOperations

Returns the RestFieldOperationsHandler for this field.

Specified by:

getRestFieldOperation in interface RestCustomFieldTypeOperations

Parameters:

field - the Custom Field

Returns:

the RestFieldOperationsHandler for this field.

getJsonDefaultValue

public JsonData getJsonDefaultValue(IssueContext issueCtx,
                                    CustomField field)

Description copied from interface: RestCustomFieldTypeOperations

Return The default data for this system field. May be null if there is no default.

Specified by:

getJsonDefaultValue in interface RestCustomFieldTypeOperations

Parameters:

issueCtx - Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.

field - the Custom Field

Returns:

The default data for this system field.

getNonNullCustomFieldProvider

public NonNullCustomFieldProvider getNonNullCustomFieldProvider()

Description copied from interface: CustomFieldType

Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.

Specified by:

getNonNullCustomFieldProvider in interface CustomFieldType<Collection<Version>,Version>

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue,
                                                   CustomFieldExportContext context)

Generates a multi column representation for all the versions in this issue. For example: {pre} Version 1, Version 2 {/pre}

Specified by:

getRepresentationFromIssue in interface ExportableCustomFieldType

Parameters:

issue - to get the representation for

context - which contains information such as the i18nHelper and field

Returns:

CustomFieldCsvRepresentation of versions.

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareCustomFieldType

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Specified by:

getFieldTypeInfo in interface RestAwareCustomFieldType

Parameters:

fieldTypeInfoContext - context information for generating the FieldTypeInfo.

Returns:

Low level information about the field.

getJsonSchema

public JsonType getJsonSchema(CustomField customField)

Description copied from interface: RestAwareCustomFieldType

Return a description of the shape of this field when represented as JSON.

Specified by:

getJsonSchema in interface RestAwareCustomFieldType

getJsonFromIssue

public FieldJsonRepresentation getJsonFromIssue(CustomField field,
                                                Issue issue,
                                                boolean renderedVersionRequested,
                                                @Nullable
                                                FieldLayoutItem fieldLayoutItem)

Description copied from interface: RestAwareCustomFieldType

Return a JsonData representation of the field value

Specified by:

getJsonFromIssue in interface RestAwareCustomFieldType

Parameters:

field - configuration of the current field

issue - to get field data from

renderedVersionRequested - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - field layout for this field.

Returns:

FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.