com.atlassian.jira.issue.customfields.impl
Class UserCFType

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,T>
      com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>
          com.atlassian.jira.issue.customfields.impl.UserCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>, SortableCustomField<com.atlassian.crowd.embedded.api.User>, RestAwareCustomFieldType, RestCustomFieldTypeOperations, UserField, UserCFNotificationTypeAware

public class UserCFType
extends AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>
implements SortableCustomField<com.atlassian.crowd.embedded.api.User>, UserCFNotificationTypeAware, ProjectImportableCustomField, UserField, RestAwareCustomFieldType, RestCustomFieldTypeOperations

Custom Field allow selection of a single User. For multi-user see MultiUserCFType

Transport Object Type

User

Database Storage Type

String of user name

Nested Class Summary

static interface

UserCFType.Visitor<T>

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

AbstractCustomFieldType.VisitorBase<X>

Field Summary

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

customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log

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

DEFAULT_VALUE_TYPE

Constructor Summary

UserCFType(CustomFieldValuePersister customFieldValuePersister, UserConverter userConverter, GenericConfigManager genericConfigManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, UserPickerSearchService searchService, JiraBaseUrls jiraBaseUrls)

Method Summary

Object	accept(AbstractCustomFieldType.VisitorBase visitor)
int	compare(com.atlassian.crowd.embedded.api.User customFieldObjectValue1, com.atlassian.crowd.embedded.api.User customFieldObjectValue2, FieldConfig fieldConfig) Compares the two custom field objects.
protected PersistenceFieldType	getDatabaseType() Type of database field needed to store this field.
protected Object	getDbValueFromObject(com.atlassian.crowd.embedded.api.User customFieldObject) Returns the database representation of the Java object as stored for that CustomField.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the 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.
protected com.atlassian.crowd.embedded.api.User	getObjectFromDbValue(Object databaseValue) Returns the Transport Object for the given Custom Field value as represented by the value stored in the database
ProjectCustomFieldImporter	getProjectImporter() Returns the object that will perform the actual project import functions for the custom field type.
RestFieldOperationsHandler	getRestFieldOperation(CustomField field) Returns the RestFieldOperationsHandler for this field.
com.atlassian.crowd.embedded.api.User	getSingularObjectFromString(String string) Returns a Singular Object, given the string value as passed by the presentation tier.
String	getStringFromSingularObject(com.atlassian.crowd.embedded.api.User value) Returns the String representation of a single value within the CustomFieldType.
com.atlassian.crowd.embedded.api.User	getValueFromCustomFieldParams(CustomFieldParams relevantParams) 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).
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.AbstractSingleFieldType

createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue

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

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, 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.notification.type.UserCFNotificationTypeAware

getValueFromIssue

Methods inherited from interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations

getJsonDefaultValue

Constructor Detail

UserCFType

public UserCFType(CustomFieldValuePersister customFieldValuePersister,
                  UserConverter userConverter,
                  GenericConfigManager genericConfigManager,
                  ApplicationProperties applicationProperties,
                  JiraAuthenticationContext authenticationContext,
                  UserPickerSearchService searchService,
                  JiraBaseUrls jiraBaseUrls)

Method Detail

getDbValueFromObject

protected Object getDbValueFromObject(com.atlassian.crowd.embedded.api.User customFieldObject)

Description copied from class: AbstractSingleFieldType

Returns the database representation of the Java object as stored for that CustomField. (eg. ProjectId if the Value represents a project). Must be compatable with type returned by AbstractSingleFieldType.getDatabaseType()

Specified by:

getDbValueFromObject in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

Parameters:

customFieldObject - the Transport Object

Returns:

String, Double or Date

getObjectFromDbValue

protected com.atlassian.crowd.embedded.api.User getObjectFromDbValue(@NotNull
                                                                     Object databaseValue)
                                                              throws FieldValidationException

Description copied from class: AbstractSingleFieldType

Returns the Transport Object for the given Custom Field value as represented by the value stored in the database

Specified by:

getObjectFromDbValue in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

Parameters:

databaseValue - - String, Double or Date objects as returned from AbstractSingleFieldType.getDbValueFromObject(Object)

Returns:

Domain object or GenericValue

Throws:

FieldValidationException - if field validation fails.

getStringFromSingularObject

public String getStringFromSingularObject(com.atlassian.crowd.embedded.api.User value)

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<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

Parameters:

value - the object

Returns:

String representation of the Object

getSingularObjectFromString

public com.atlassian.crowd.embedded.api.User 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<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

Parameters:

string - the String

Returns:

singularObject instance

Throws:

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

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<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

Overrides:

validateFromParams in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

Parameters:

relevantParams - parameter object of Strings

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

config - FieldConfig

getValueFromCustomFieldParams

public com.atlassian.crowd.embedded.api.User getValueFromCustomFieldParams(CustomFieldParams relevantParams)
                                                                    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<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

Overrides:

getValueFromCustomFieldParams in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

Parameters:

relevantParams - 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)

compare

public int compare(@NotNull
                   com.atlassian.crowd.embedded.api.User customFieldObjectValue1,
                   @NotNull
                   com.atlassian.crowd.embedded.api.User customFieldObjectValue2,
                   FieldConfig fieldConfig)

Description copied from interface: SortableCustomField

Compares the two custom field objects.

Specified by:

compare in interface SortableCustomField<com.atlassian.crowd.embedded.api.User>

Parameters:

customFieldObjectValue1 - Never null

customFieldObjectValue2 - Never null

Returns:

0, 1 or -1

getDatabaseType

@NotNull
protected PersistenceFieldType getDatabaseType()

Description copied from class: AbstractSingleFieldType

Type of database field needed to store this field.

Specified by:

getDatabaseType in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

Returns:

One of the predefined PersistenceFieldType types.

getVelocityParameters

@NotNull
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<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

Overrides:

getVelocityParameters in class AbstractCustomFieldType<com.atlassian.crowd.embedded.api.User,com.atlassian.crowd.embedded.api.User>

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.

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class AbstractSingleFieldType<com.atlassian.crowd.embedded.api.User>

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.

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.