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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TextAreaCFType

public class RenderableTextCFType
extends GenericTextCFType

This custom field type returns true for its isRenderable method and is meant to represent a text custom field type that is renderable.

Nested Class Summary

static interface

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

RenderableTextCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager)

RenderableTextCFType(CustomFieldValuePersister customFieldValuePersister, StringConverter stringConverter, GenericConfigManager genericConfigManager)
Deprecated. Use RenderableTextCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager) instead. Since v5.0.

Method Summary

Object	accept(AbstractCustomFieldType.VisitorBase visitor)
boolean	isRenderable() This is a mirror of the method from the RenderableField interface and is needed to bridge the gap between CustomFields and CustomFieldTypes.
boolean	valuesEqual(String v1, String v2) Used to compare 2 field values and work out whether a change item should be generated

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

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

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

createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, 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

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

RenderableTextCFType

public RenderableTextCFType(CustomFieldValuePersister customFieldValuePersister,
                            GenericConfigManager genericConfigManager)

RenderableTextCFType

@Deprecated
public RenderableTextCFType(CustomFieldValuePersister customFieldValuePersister,
                                       StringConverter stringConverter,
                                       GenericConfigManager genericConfigManager)

Deprecated. Use RenderableTextCFType(com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager) instead. Since v5.0.

Parameters:

customFieldValuePersister -

stringConverter -

genericConfigManager -

Method Detail

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.

valuesEqual

public boolean valuesEqual(String v1,
                           String v2)

Description copied from interface: CustomFieldType

Used to compare 2 field values and work out whether a change item should be generated

Specified by:

valuesEqual in interface CustomFieldType<String,String>

Overrides:

valuesEqual in class AbstractCustomFieldType<String,String>

Parameters:

v1 - current value

v2 - new value

Returns:

true if the change item should be generated, false otherwise

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class GenericTextCFType