com.atlassian.jira.issue.customfields.impl

Class StringCFType

java.lang.Object

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

com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType

com.atlassian.jira.issue.customfields.impl.StringCFType

All Implemented Interfaces:

CustomFieldType, TextCustomFieldType, RestAwareCustomFieldType

Direct Known Subclasses:

TextCFType

Deprecated.

Use GenericTextCFType instead. Since v5.0.

@Deprecated
 @PublicSpi
public abstract class StringCFType
extends AbstractSingleFieldType
implements RestAwareCustomFieldType, TextCustomFieldType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringCFType.Visitor<T> Deprecated.

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 and Description
StringCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager) Deprecated. Use StringCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager, com.atlassian.jira.issue.fields.TextFieldCharacterLengthValidator, com.atlassian.jira.security.JiraAuthenticationContext) instead. Since v6.4.1
StringCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, TextFieldCharacterLengthValidator textFieldCharacterLengthValidator, JiraAuthenticationContext jiraAuthenticationContext) Deprecated.

Method Summary

Modifier and Type	Method and Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor) Deprecated.
protected Object	getDbValueFromObject(Object customFieldObject) Deprecated. Returns the database representation of the Java object as stored for that CustomField.
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Deprecated. Returns lower level Information about the field.
FieldJsonRepresentation	getJsonFromIssue(CustomField field, Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Deprecated. Return a JsonData representation of the field value
JsonType	getJsonSchema(CustomField customField) Deprecated. Return a description of the shape of this field when represented as JSON.
protected Object	getObjectFromDbValue(Object databaseValue) Deprecated. Returns the Transport Object for the given Custom Field value as represented by the value stored in the database
String	getValueFromCustomFieldParams(CustomFieldParams relevantParams) Deprecated. Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.

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

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

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

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, 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, getSingularObjectFromString, getStringFromSingularObject, isUserInputRequiredForMove

Constructor Detail

StringCFType

@Deprecated
public StringCFType(CustomFieldValuePersister customFieldValuePersister,
                                GenericConfigManager genericConfigManager)

Deprecated. Use StringCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager, com.atlassian.jira.issue.fields.TextFieldCharacterLengthValidator, com.atlassian.jira.security.JiraAuthenticationContext) instead. Since v6.4.1

Constructor.

StringCFType

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

Deprecated.

Method Detail

getDbValueFromObject

protected Object getDbValueFromObject(Object customFieldObject)

Deprecated.

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

Parameters:

customFieldObject - the Transport Object

Returns:

String, Double or Date

getObjectFromDbValue

protected Object getObjectFromDbValue(@Nonnull
                                      Object databaseValue)
                               throws FieldValidationException

Deprecated.

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

Parameters:

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

Returns:

Domain object or GenericValue

Throws:

FieldValidationException - if field validation fails.

getValueFromCustomFieldParams

public String getValueFromCustomFieldParams(CustomFieldParams relevantParams)
                                     throws FieldValidationException

Deprecated.

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

Overrides:

getValueFromCustomFieldParams in class AbstractSingleFieldType

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)

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Deprecated.

Overrides:

accept in class AbstractSingleFieldType

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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.