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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,T>
      extended by com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<String>
          extended by com.atlassian.jira.issue.customfields.impl.GenericTextCFType
All Implemented Interfaces:
ProjectImportableCustomField, CustomFieldType<String,String>, SortableCustomField<String>, RestAwareCustomFieldType, RestCustomFieldTypeOperations
Direct Known Subclasses:
ReadOnlyCFType, RenderableTextCFType, URLCFType

@PublicSpi
public class GenericTextCFType
extends AbstractSingleFieldType<String>
implements SortableCustomField<String>, ProjectImportableCustomField, RestAwareCustomFieldType, RestCustomFieldTypeOperations

A CustomFieldType where data is stored and displayed as a single String By default it will only have a Limited Text Field for storage (if you need bigger override getDatabaseType())

Transport Object Type
String
Database Storage Type
String

Since:
v5.0

Nested Class Summary
static interface GenericTextCFType.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
protected GenericTextCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager)
           
 
Method Summary
 Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 int compare(String customFieldObjectValue1, String customFieldObjectValue2, FieldConfig fieldConfig)
          Compares the two custom field objects.
protected  PersistenceFieldType getDatabaseType()
          Type of database field needed to store this field.
protected  Object getDbValueFromObject(String 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  String 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.
 String getSingularObjectFromString(String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 String getStringFromSingularObject(String value)
          Returns the String representation of a single value within the CustomFieldType.
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, 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.fields.rest.RestCustomFieldTypeOperations
getJsonDefaultValue
 

Constructor Detail

GenericTextCFType

protected GenericTextCFType(CustomFieldValuePersister customFieldValuePersister,
                            GenericConfigManager genericConfigManager)
Method Detail

getDbValueFromObject

protected Object getDbValueFromObject(String 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<String>
Parameters:
customFieldObject - the Transport Object
Returns:
String, Double or Date

getObjectFromDbValue

protected String getObjectFromDbValue(@Nonnull
                                      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<String>
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(String 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<String,String>
Parameters:
value - the object
Returns:
String representation of the Object

getSingularObjectFromString

public String 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<String,String>
Parameters:
string - the String
Returns:
singularObject instance
Throws:
FieldValidationException - if the string is an invalid representation of the Object.

getDatabaseType

@Nonnull
protected PersistenceFieldType getDatabaseType()
Description copied from class: AbstractSingleFieldType
Type of database field needed to store this field.

Specified by:
getDatabaseType in class AbstractSingleFieldType<String>
Returns:
One of the predefined PersistenceFieldType types.

compare

public int compare(@Nonnull
                   String customFieldObjectValue1,
                   @Nonnull
                   String customFieldObjectValue2,
                   FieldConfig fieldConfig)
Description copied from interface: SortableCustomField
Compares the two custom field objects.

Specified by:
compare in interface SortableCustomField<String>
Parameters:
customFieldObjectValue1 - Never null
customFieldObjectValue2 - Never null
Returns:
0, 1 or -1

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

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.


Copyright © 2002-2014 Atlassian. All Rights Reserved.