com.atlassian.jira.issue.customfields.impl
Class TextCFType
java.lang.Object
com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
com.atlassian.jira.issue.customfields.impl.StringCFType
com.atlassian.jira.issue.customfields.impl.TextCFType
- All Implemented Interfaces:
- ProjectImportableCustomField, CustomFieldType, SortableCustomField<String>
- Direct Known Subclasses:
- AbstractMultiCFType, ReadOnlyCFType, RenderableTextCFType, SelectCFType
public class TextCFType
- extends StringCFType
- implements SortableCustomField<String>, ProjectImportableCustomField
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 |
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
- CustomFieldValuePersisterstringConverter
- StringConvertergenericConfigManager
- GenericConfigManager- See Also:
TextCFType(CustomFieldValuePersister, GenericConfigManager)
getStringFromSingularObject
public String getStringFromSingularObject(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 Object 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
- Parameters:
string
- the String
- Returns:
- singularObject instance
- Throws:
FieldValidationException
- if the string is an invalid representation of the Object.
compare
public int compare(String customFieldObjectValue1,
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 nullcustomFieldObjectValue2
- 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()
Copyright © 2002-2010 Atlassian. All Rights Reserved.