Package com.atlassian.jira.issue.customfields.impl

Class ReadOnlyCFType

java.lang.Object

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

com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<String>

com.atlassian.jira.issue.customfields.impl.GenericTextCFType

com.atlassian.jira.issue.customfields.impl.ReadOnlyCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<String,String>, SortableCustomField<String>, TextCustomFieldType, ExportableCustomFieldType, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class ReadOnlyCFType
extends GenericTextCFType
implements ExportableCustomFieldType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReadOnlyCFType.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, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor	Description
ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, TextFieldCharacterLengthValidator textFieldCharacterLengthValidator, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method	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.
String	getChangelogValue(CustomField field, String value)	Returns a values to be stored in the change log, example is the id of the changed item.
NonNullCustomFieldProvider	getNonNullCustomFieldProvider()	Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.
FieldExportParts	getRepresentationFromIssue(Issue issue, CustomFieldExportContext context)	Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.
boolean	isRenderable()	This is a mirror of the method from the RenderableField interface and is needed to bridge the gap between CustomFields and CustomFieldTypes.
void	updateValue(CustomField customField, Issue issue, String value)	the value does exist, and the new value is different than the existing one.

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

compare, getDatabaseType, getDbValueFromObject, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getObjectFromDbValue, getProjectImporter, getRestFieldOperation, getSingularObjectFromString, getStringFromSingularObject, getValueFromCustomFieldParams

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

createValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, validateFromParams

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

assertObjectImplementsType, getChangelogString, getConfigurationItemTypes, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, getVelocityParameters, init, 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, isUserInputRequiredForMove, requiresAdditionalParams

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

getJsonDefaultValue

Constructor Details

ReadOnlyCFType

public ReadOnlyCFType(CustomFieldValuePersister customFieldValuePersister,
 GenericConfigManager genericConfigManager,
 TextFieldCharacterLengthValidator textFieldCharacterLengthValidator,
 JiraAuthenticationContext jiraAuthenticationContext)

Method Details

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<String,String>

updateValue

public void updateValue(CustomField customField,
 Issue issue,
 String value)

Description copied from class: AbstractSingleFieldType

the value does exist, and the new value is different than the existing one.

Specified by:

updateValue in interface CustomFieldType<String,String>

Overrides:

updateValue in class AbstractSingleFieldType<String>

Parameters:

customField - 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.

getChangelogValue

public String getChangelogValue(CustomField field,
 String value)

Description copied from interface: CustomFieldType

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

Specified by:

getChangelogValue in interface CustomFieldType<String,String>

Overrides:

getChangelogValue in class AbstractSingleFieldType<String>

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log value.

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<String,String>

Overrides:

availableForBulkEdit in class AbstractCustomFieldType<String,String>

Parameters:

bulkEditBean - BulkEditBean

Returns:

null if available for bulk edit or appropriate unavailable message

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class GenericTextCFType

isRenderable

public boolean isRenderable()

Description copied from interface: CustomFieldType

This is a mirror of the method from the RenderableField interface and is needed to bridge the gap between CustomFields and CustomFieldTypes.

Specified by:

isRenderable in interface CustomFieldType<String,String>

Overrides:

isRenderable in class AbstractCustomFieldType<String,String>

Returns:

true if the field is configurable for use with the renderers, a text based field, false otherwise.

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue,
 CustomFieldExportContext context)

Description copied from interface: ExportableCustomFieldType

Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.

Specified by:

getRepresentationFromIssue in interface ExportableCustomFieldType

Parameters:

issue - to get the representation for

context - which contains information such as the i18nHelper and field

Returns:

the exportable parts of this issue