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

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

All Implemented Interfaces:

CustomFieldType

Direct Known Subclasses:

AbstractMultiSettableCFType, AbstractSingleFieldType, CalculatedCFType, VersionCFType

public abstract class AbstractCustomFieldType
extends Object
implements CustomFieldType

Field Summary

Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType

DEFAULT_VALUE_TYPE

Constructor Summary

AbstractCustomFieldType()

Method Summary

protected void	assertObjectImplementsType(Class clazz, Object o)
String	availableForBulkEdit(BulkEditBean bulkEditBean) Allow the custom field type perform a specific check as to its availability for bulk editing.
String	getChangelogString(CustomField field, Object value) Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.
List	getConfigurationItemTypes() Returns a List of FieldConfigItemType objects.
String	getDescription()
CustomFieldTypeModuleDescriptor	getDescriptor()
protected I18nBean	getI18nBean()
String	getKey() Returns the full key of the CustomFieldType.
String	getName()
List	getRelatedIndexers(CustomField customField) Returns a list of indexers that will be used for the field.
Map	getVelocityParameters(Issue issue) Deprecated. Use the method getVelocityParameters(Issue, CustomField, FieldLayoutItem) instead
Map	getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem) The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).
void	init(CustomFieldTypeModuleDescriptor descriptor) Initialises the CustomFieldType with the given descriptor.
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(Object v1, Object v2) Used to compare 2 field values and work out whether a change item should be generated

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

createValue, getChangelogValue, getDefaultValue, getSingularObjectFromString, getStringFromSingularObject, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams

Constructor Detail

AbstractCustomFieldType

public AbstractCustomFieldType()

Method Detail

init

public void init(CustomFieldTypeModuleDescriptor descriptor)

Description copied from interface: CustomFieldType

Initialises the CustomFieldType with the given descriptor.

Specified by:

init in interface CustomFieldType

getKey

public final String getKey()

Description copied from interface: CustomFieldType

Returns the full key of the CustomFieldType. Typically, this will be prefixed with "com.atlassian.jira.plugin.system.customfieldtypes:"

Specified by:

getKey in interface CustomFieldType

Returns:

CustomFieldType Key prefixed with the Package

getName

public final String getName()

Specified by:

getName in interface CustomFieldType

getDescription

public final String getDescription()

Specified by:

getDescription in interface CustomFieldType

getDescriptor

public final CustomFieldTypeModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface CustomFieldType

getVelocityParameters

public Map getVelocityParameters(Issue issue,
                                 CustomField field,
                                 FieldLayoutItem fieldLayoutItem)

Description copied from interface: CustomFieldType

The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).

The values are added to the context for all velocity views (edit, search, view, xml)

Specified by:

getVelocityParameters in interface CustomFieldType

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)

getVelocityParameters

public Map getVelocityParameters(Issue issue)

Deprecated. Use the method getVelocityParameters(Issue, CustomField, FieldLayoutItem) instead

This method is for backwards compatibility.

Parameters:

issue -

Returns:

velocity params

getConfigurationItemTypes

public List getConfigurationItemTypes()

Description copied from interface: CustomFieldType

Returns a List of FieldConfigItemType objects. This opens up possibilties for configurable custom fields

Specified by:

getConfigurationItemTypes in interface CustomFieldType

Returns:

List of FieldConfigItemType

getRelatedIndexers

public List getRelatedIndexers(CustomField customField)

Description copied from interface: CustomFieldType

Returns a list of indexers that will be used for the field. This will over-ride the anonymous searcher specified by AbstractCustomFieldSearcher.getRelatedIndexers() and AbstractCustomFieldSearcher.index(Document, CustomField, Object)

Specified by:

getRelatedIndexers in interface CustomFieldType

Returns:

List of instantiated and initialised FieldIndexer objects. Null if no related indexers.

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

Returns:

true if the field is configurable for use with the renderers, a text based field, false otherwise.

valuesEqual

public boolean valuesEqual(Object v1,
                           Object 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

Parameters:

v1 - current value

v2 - new value

Returns:

true if teh change item should be generated, false otherwise

getChangelogString

public String getChangelogString(CustomField field,
                                 Object value)

Description copied from interface: CustomFieldType

Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.

Specified by:

getChangelogString in interface CustomFieldType

Parameters:

field - CustomField that the value belongs to

value - Transport Object representing the value instance of the CustomField

Returns:

Change log string.

assertObjectImplementsType

protected void assertObjectImplementsType(Class clazz,
                                          Object o)

availableForBulkEdit

public String availableForBulkEdit(BulkEditBean bulkEditBean)

Description copied from interface: CustomFieldType

Allow the custom field type perform a specific check as to its availability for bulk editing.

Specified by:

availableForBulkEdit in interface CustomFieldType

Returns:

null if available for bulk edit or appropriate unavailable message

getI18nBean

protected I18nBean getI18nBean()