com.atlassian.greenhopper.customfield.epiclink
Class EpicLinkCFType

java.lang.Object
  com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>
      com.atlassian.greenhopper.customfield.epiclink.EpicLinkCFType

All Implemented Interfaces:

MetadataCFType, com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

public class EpicLinkCFType
extends com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>
implements MetadataCFType

A custom field type to allow GreenHopper to store extra information about the Epic-Issue relationship in the index.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType

com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType.Visitor<X>, com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType.VisitorBase<X>

Field Summary

static CustomFieldMetadata

CUSTOMFIELD_METADATA the metadata needed to define the custom field in JIRA

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

DEFAULT_VALUE_TYPE

Constructor Summary

protected

EpicLinkCFType(EpicLinkManager epicLinkManager, EpicService epicService, com.atlassian.jira.issue.IssueManager issueManager, IssueTypeService issueTypeService, EpicCustomFieldService epicCustomFieldService, com.atlassian.jira.security.JiraAuthenticationContext authCtx, com.atlassian.jira.util.velocity.VelocityRequestContextFactory requestContextFactory, EpicLabelProviderImpl epicLabelProvider)

Method Summary

void	createValue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.Issue epic)
java.lang.String	getChangelogValue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue value)
com.atlassian.jira.issue.Issue	getDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig fieldConfig)
java.lang.String	getEpicColor(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue)
java.lang.String	getEpicDisplayName(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue)
java.lang.String	getEpicKey(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue)
java.lang.String	getEpicUrl(com.atlassian.jira.issue.fields.CustomField customField, com.atlassian.jira.issue.Issue issue)
java.lang.String	getIssueOfTypeEpicErrorMessage()
CustomFieldMetadata	getMetadata()
com.atlassian.jira.issue.Issue	getSingularObjectFromString(java.lang.String epicKeyOrName)
java.lang.String	getStringFromSingularObject(com.atlassian.jira.issue.Issue issue)
java.lang.Object	getStringValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
java.lang.String	getSubtaskErrorMessage()
com.atlassian.jira.issue.Issue	getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
com.atlassian.jira.issue.Issue	getValueFromIssue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue)
boolean	isIssueOfTypeEpic(com.atlassian.jira.issue.Issue issue)
boolean	isSubtask(com.atlassian.jira.issue.Issue issue)
boolean	isValidIssue(com.atlassian.jira.issue.Issue issue)
java.util.Set<java.lang.Long>	remove(com.atlassian.jira.issue.fields.CustomField field)
void	setDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig fieldConfig, com.atlassian.jira.issue.Issue value)
void	updateValue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.Issue epic)
void	validateFromParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams relevantParams, com.atlassian.jira.util.ErrorCollection errorCollectionToAddTo, com.atlassian.jira.issue.fields.config.FieldConfig config)

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

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

Field Detail

CUSTOMFIELD_METADATA

public static final CustomFieldMetadata CUSTOMFIELD_METADATA

the metadata needed to define the custom field in JIRA

Constructor Detail

EpicLinkCFType

protected EpicLinkCFType(EpicLinkManager epicLinkManager,
                         EpicService epicService,
                         com.atlassian.jira.issue.IssueManager issueManager,
                         IssueTypeService issueTypeService,
                         EpicCustomFieldService epicCustomFieldService,
                         com.atlassian.jira.security.JiraAuthenticationContext authCtx,
                         com.atlassian.jira.util.velocity.VelocityRequestContextFactory requestContextFactory,
                         EpicLabelProviderImpl epicLabelProvider)

Method Detail

getStringFromSingularObject

public java.lang.String getStringFromSingularObject(com.atlassian.jira.issue.Issue issue)

Specified by:

getStringFromSingularObject in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

getSingularObjectFromString

public com.atlassian.jira.issue.Issue getSingularObjectFromString(java.lang.String epicKeyOrName)
                                                           throws com.atlassian.jira.issue.customfields.impl.FieldValidationException

Specified by:

getSingularObjectFromString in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

Throws:

com.atlassian.jira.issue.customfields.impl.FieldValidationException

remove

public java.util.Set<java.lang.Long> remove(com.atlassian.jira.issue.fields.CustomField field)

Specified by:

remove in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

validateFromParams

public void validateFromParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams relevantParams,
                               com.atlassian.jira.util.ErrorCollection errorCollectionToAddTo,
                               com.atlassian.jira.issue.fields.config.FieldConfig config)

Specified by:

validateFromParams in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

createValue

public void createValue(com.atlassian.jira.issue.fields.CustomField field,
                        com.atlassian.jira.issue.Issue issue,
                        com.atlassian.jira.issue.Issue epic)

Specified by:

createValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

updateValue

public void updateValue(com.atlassian.jira.issue.fields.CustomField field,
                        com.atlassian.jira.issue.Issue issue,
                        com.atlassian.jira.issue.Issue epic)

Specified by:

updateValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

isValidIssue

public boolean isValidIssue(com.atlassian.jira.issue.Issue issue)

getValueFromCustomFieldParams

public com.atlassian.jira.issue.Issue getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
                                                             throws com.atlassian.jira.issue.customfields.impl.FieldValidationException

Specified by:

getValueFromCustomFieldParams in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

Throws:

com.atlassian.jira.issue.customfields.impl.FieldValidationException

getStringValueFromCustomFieldParams

public java.lang.Object getStringValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)

Specified by:

getStringValueFromCustomFieldParams in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

getValueFromIssue

public com.atlassian.jira.issue.Issue getValueFromIssue(com.atlassian.jira.issue.fields.CustomField field,
                                                        com.atlassian.jira.issue.Issue issue)

Specified by:

getValueFromIssue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

getDefaultValue

public com.atlassian.jira.issue.Issue getDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig fieldConfig)

Specified by:

getDefaultValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

setDefaultValue

public void setDefaultValue(com.atlassian.jira.issue.fields.config.FieldConfig fieldConfig,
                            com.atlassian.jira.issue.Issue value)

Specified by:

setDefaultValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

getChangelogValue

public java.lang.String getChangelogValue(com.atlassian.jira.issue.fields.CustomField field,
                                          com.atlassian.jira.issue.Issue value)

Specified by:

getChangelogValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.Issue>

getMetadata

public CustomFieldMetadata getMetadata()

Specified by:

getMetadata in interface MetadataCFType

getEpicKey

public java.lang.String getEpicKey(com.atlassian.jira.issue.fields.CustomField customField,
                                   com.atlassian.jira.issue.Issue issue)

getEpicDisplayName

public java.lang.String getEpicDisplayName(com.atlassian.jira.issue.fields.CustomField customField,
                                           com.atlassian.jira.issue.Issue issue)

getEpicColor

public java.lang.String getEpicColor(com.atlassian.jira.issue.fields.CustomField customField,
                                     com.atlassian.jira.issue.Issue issue)

isIssueOfTypeEpic

public boolean isIssueOfTypeEpic(com.atlassian.jira.issue.Issue issue)

isSubtask

public boolean isSubtask(com.atlassian.jira.issue.Issue issue)

getIssueOfTypeEpicErrorMessage

public java.lang.String getIssueOfTypeEpicErrorMessage()

getSubtaskErrorMessage

public java.lang.String getSubtaskErrorMessage()

getEpicUrl

public java.lang.String getEpicUrl(com.atlassian.jira.issue.fields.CustomField customField,
                                   com.atlassian.jira.issue.Issue issue)