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

public abstract class AbstractCustomFieldType

extends java.lang.Object

implements CustomFieldType

Constructor Summary

AbstractCustomFieldType()

Method Summary

protected void	assertObjectImplementsType(java.lang.Class clazz, java.lang.Object o)
java.lang.String	getDescription()
CustomFieldTypeModuleDescriptor	getDescriptor()
java.lang.String	getKey() Returns the full key of the CustomFieldType.
java.lang.String	getName()
java.util.Map	getVelocityParameters(org.ofbiz.core.entity.GenericValue issue) 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.

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

Parameters:

descriptor -

getKey

public final java.lang.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 java.lang.String getName()

Specified by:

getName in interface CustomFieldType

getDescription

public final java.lang.String getDescription()

Specified by:

getDescription in interface CustomFieldType

getDescriptor

public final CustomFieldTypeModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface CustomFieldType

getVelocityParameters

public java.util.Map getVelocityParameters(org.ofbiz.core.entity.GenericValue issue)

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)

assertObjectImplementsType

protected void assertObjectImplementsType(java.lang.Class clazz,
                                          java.lang.Object o)