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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      extended by com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
          extended by com.atlassian.jira.issue.customfields.impl.StringCFType
              extended by com.atlassian.jira.issue.customfields.impl.TextCFType
All Implemented Interfaces:
ProjectImportableCustomField, CustomFieldType, SortableCustomField<java.lang.String>
Direct Known Subclasses:
AbstractMultiCFType, ReadOnlyCFType, RenderableTextCFType, SelectCFType

public class TextCFType
extends StringCFType
implements SortableCustomField<java.lang.String>, ProjectImportableCustomField


Nested Class Summary
static interface TextCFType.Visitor<T>
           
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
AbstractCustomFieldType.VisitorBase<T>
 
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
TextCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager)
           
TextCFType(CustomFieldValuePersister customFieldValuePersister, StringConverter stringConverter, GenericConfigManager genericConfigManager)
          Deprecated. - We no longer require an instance of StringConverter. Use TextCFType(CustomFieldValuePersister, GenericConfigManager). Since v4.0.
 
Method Summary
 java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 int compare(java.lang.String customFieldObjectValue1, java.lang.String customFieldObjectValue2, FieldConfig fieldConfig)
          Compares the two custom field objects.
protected  PersistenceFieldType getDatabaseType()
          Type of database field needed to store this field.
 ProjectCustomFieldImporter getProjectImporter()
          This method will return a NoTransformationCustomFieldImporter, be mindful that if you are extending this class you need to have a good hard think about whether this is the right field importer for your custom field values.
 java.lang.Object getSingularObjectFromString(java.lang.String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 java.lang.String getStringFromSingularObject(java.lang.Object value)
          Returns the String representation of a single value within the CustomFieldType.
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.StringCFType
getDbValueFromObject, getObjectFromDbValue
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
createValue, getChangelogValue, getDefaultValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, 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
 

Constructor Detail

TextCFType

public TextCFType(CustomFieldValuePersister customFieldValuePersister,
                  GenericConfigManager genericConfigManager)

TextCFType

public TextCFType(CustomFieldValuePersister customFieldValuePersister,
                  StringConverter stringConverter,
                  GenericConfigManager genericConfigManager)
Deprecated. - We no longer require an instance of StringConverter. Use TextCFType(CustomFieldValuePersister, GenericConfigManager). Since v4.0.

This constructor is deprecated and is left only for backward compatibility in 3rd party plugins. It will be removed from a future version of JIRA.

Parameters:
customFieldValuePersister - CustomFieldValuePersister
stringConverter - StringConverter
genericConfigManager - GenericConfigManager
See Also:
TextCFType(CustomFieldValuePersister, GenericConfigManager)
Method Detail

getStringFromSingularObject

public java.lang.String getStringFromSingularObject(java.lang.Object value)
Description copied from interface: CustomFieldType
Returns the String representation of a single value within the CustomFieldType. This is the value that will 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 CustomFieldParams

Specified by:
getStringFromSingularObject in interface CustomFieldType
Parameters:
value - the object
Returns:
String representation of the Object

getSingularObjectFromString

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

compare

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

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

getDatabaseType

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

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

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()
This method will return a NoTransformationCustomFieldImporter, be mindful that if you are extending this class you need to have a good hard think about whether this is the right field importer for your custom field values.

Specified by:
getProjectImporter in interface ProjectImportableCustomField
Returns:
a NoTransformationCustomFieldImporter
See Also:
ProjectImportableCustomField.getProjectImporter()

accept

public java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
Overrides:
accept in class StringCFType


Copyright © 2002-2010 Atlassian. All Rights Reserved.