|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
public abstract class AbstractCustomFieldType
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 |
---|
public AbstractCustomFieldType()
Method Detail |
---|
public void init(CustomFieldTypeModuleDescriptor descriptor)
CustomFieldType
init
in interface CustomFieldType
public final String getKey()
CustomFieldType
getKey
in interface CustomFieldType
public final String getName()
getName
in interface CustomFieldType
public final String getDescription()
getDescription
in interface CustomFieldType
public final CustomFieldTypeModuleDescriptor getDescriptor()
getDescriptor
in interface CustomFieldType
public Map getVelocityParameters(Issue issue, CustomField field, FieldLayoutItem fieldLayoutItem)
CustomFieldType
getVelocityParameters
in interface CustomFieldType
issue
- The issue currently in context (Note: this will be null in cases like 'default value')
Map
of parameters to add to the velocity context, or an empty Map otherwise (never null)public Map getVelocityParameters(Issue issue)
getVelocityParameters(Issue, CustomField, FieldLayoutItem)
instead
issue
-
public List getConfigurationItemTypes()
CustomFieldType
FieldConfigItemType
objects.
This opens up possibilties for configurable custom fields
getConfigurationItemTypes
in interface CustomFieldType
FieldConfigItemType
public List getRelatedIndexers(CustomField customField)
CustomFieldType
AbstractCustomFieldSearcher.getRelatedIndexers()
and AbstractCustomFieldSearcher.index(Document,
CustomField, Object)
getRelatedIndexers
in interface CustomFieldType
FieldIndexer
objects. Null if no related indexers.public boolean isRenderable()
CustomFieldType
isRenderable
in interface CustomFieldType
public boolean valuesEqual(Object v1, Object v2)
CustomFieldType
valuesEqual
in interface CustomFieldType
v1
- current valuev2
- new value
public String getChangelogString(CustomField field, Object value)
CustomFieldType
getChangelogString
in interface CustomFieldType
field
- CustomField that the value belongs tovalue
- Transport Object representing the value instance of the CustomField
protected void assertObjectImplementsType(Class clazz, Object o)
public String availableForBulkEdit(BulkEditBean bulkEditBean)
CustomFieldType
availableForBulkEdit
in interface CustomFieldType
protected I18nBean getI18nBean()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |