com.atlassian.greenhopper.customfield.sprint
Class SprintCFType

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<java.util.Collection<S>,S>
      extended by com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>
          extended by com.atlassian.greenhopper.customfield.sprint.SprintCFType
All Implemented Interfaces:
com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>

public class SprintCFType
extends com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

Singular Object is Sprint, Transport Object is Set (Much like the LabelsCFType)


Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType
com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType.Visitor<X>
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType.VisitorBase<X>
 
Field Summary
static CustomFieldMetadata CUSTOMFIELD_METADATA
          the meta-data needed to define the custom field in JIRA
static com.atlassian.jira.JiraDataType SPRINT
          Backlog JiraDataType.
 
Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType
customFieldValuePersister, genericConfigManager
 
Fields inherited from interface com.atlassian.jira.issue.customfields.CustomFieldType
DEFAULT_VALUE_TYPE
 
Constructor Summary
SprintCFType(SprintManager sprintManager, WebUtilities webUtilities, com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister customFieldValuePersister, com.atlassian.jira.issue.customfields.manager.GenericConfigManager genericConfigManager, I18nFactoryService i18nFactory, com.atlassian.jira.security.JiraAuthenticationContext authenticationContext)
          Overriden, calls super constructor.
 
Method Summary
protected  Sprint convertDbValueToType(java.lang.Object dbValue)
           
protected  java.lang.Object convertTypeToDbValue(Sprint sprint)
           
 java.lang.String getChangelogString(com.atlassian.jira.issue.fields.CustomField field, java.util.Collection<Sprint> values)
           
 java.lang.String getChangelogValue(com.atlassian.jira.issue.fields.CustomField field, java.util.Collection<Sprint> values)
           
protected  com.atlassian.jira.issue.customfields.persistence.PersistenceFieldType getDatabaseType()
           
 Sprint getSingularObjectFromString(java.lang.String idAsString)
           
 java.lang.String getStringFromSingularObject(Sprint sprint)
           
 java.lang.Object getStringValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
           
protected  java.util.Comparator<Sprint> getTypeComparator()
           
 java.util.Collection<Sprint> getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
           
 java.util.Collection<Sprint> getValueFromIssue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue)
           
 java.util.Map<java.lang.String,java.lang.Object> getVelocityParameters(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem fieldLayoutItem)
           
 boolean isRenderable()
           
 void validateFromParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams relevantParams, com.atlassian.jira.util.ErrorCollection errorCollectionToAddTo, com.atlassian.jira.issue.fields.config.FieldConfig config)
           
 boolean valuesEqual(java.util.Collection<Sprint> v1, java.util.Collection<Sprint> v2)
           
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType
accept, convertDbObjectToTypes, convertTypesToDbObjects, createValue, getDefaultValue, remove, setDefaultValue, updateValue
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
assertObjectImplementsType, availableForBulkEdit, getConfigurationItemTypes, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init
 
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 meta-data needed to define the custom field in JIRA


SPRINT

public static final com.atlassian.jira.JiraDataType SPRINT
Backlog JiraDataType. See JIRA data types

Constructor Detail

SprintCFType

public SprintCFType(SprintManager sprintManager,
                    WebUtilities webUtilities,
                    com.atlassian.jira.issue.customfields.persistence.CustomFieldValuePersister customFieldValuePersister,
                    com.atlassian.jira.issue.customfields.manager.GenericConfigManager genericConfigManager,
                    I18nFactoryService i18nFactory,
                    com.atlassian.jira.security.JiraAuthenticationContext authenticationContext)
Overriden, calls super constructor.

Method Detail

getSingularObjectFromString

public Sprint getSingularObjectFromString(java.lang.String idAsString)
                                   throws com.atlassian.jira.issue.customfields.impl.FieldValidationException
Throws:
com.atlassian.jira.issue.customfields.impl.FieldValidationException

getStringFromSingularObject

public java.lang.String getStringFromSingularObject(Sprint sprint)

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)

getValueFromCustomFieldParams

public java.util.Collection<Sprint> getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
                                                           throws com.atlassian.jira.issue.customfields.impl.FieldValidationException
Throws:
com.atlassian.jira.issue.customfields.impl.FieldValidationException

getStringValueFromCustomFieldParams

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

getVelocityParameters

public java.util.Map<java.lang.String,java.lang.Object> getVelocityParameters(com.atlassian.jira.issue.Issue issue,
                                                                              com.atlassian.jira.issue.fields.CustomField field,
                                                                              com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem fieldLayoutItem)
Specified by:
getVelocityParameters in interface com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>
Overrides:
getVelocityParameters in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<java.util.Collection<Sprint>,Sprint>

getValueFromIssue

public java.util.Collection<Sprint> 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<java.util.Collection<Sprint>,Sprint>
Overrides:
getValueFromIssue in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

isRenderable

public boolean isRenderable()
Specified by:
isRenderable in interface com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>
Overrides:
isRenderable in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<java.util.Collection<Sprint>,Sprint>

getTypeComparator

protected java.util.Comparator<Sprint> getTypeComparator()
Specified by:
getTypeComparator in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

convertTypeToDbValue

protected java.lang.Object convertTypeToDbValue(@Nullable
                                                Sprint sprint)
Specified by:
convertTypeToDbValue in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

convertDbValueToType

protected Sprint convertDbValueToType(@Nullable
                                      java.lang.Object dbValue)
Specified by:
convertDbValueToType in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

getDatabaseType

protected com.atlassian.jira.issue.customfields.persistence.PersistenceFieldType getDatabaseType()
Specified by:
getDatabaseType in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

valuesEqual

public boolean valuesEqual(java.util.Collection<Sprint> v1,
                           java.util.Collection<Sprint> v2)
Specified by:
valuesEqual in interface com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>
Overrides:
valuesEqual in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<java.util.Collection<Sprint>,Sprint>

getChangelogValue

public java.lang.String getChangelogValue(com.atlassian.jira.issue.fields.CustomField field,
                                          java.util.Collection<Sprint> values)
Specified by:
getChangelogValue in interface com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>
Overrides:
getChangelogValue in class com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>

getChangelogString

public java.lang.String getChangelogString(com.atlassian.jira.issue.fields.CustomField field,
                                           java.util.Collection<Sprint> values)
Specified by:
getChangelogString in interface com.atlassian.jira.issue.customfields.CustomFieldType<java.util.Collection<Sprint>,Sprint>
Overrides:
getChangelogString in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<java.util.Collection<Sprint>,Sprint>


Copyright © 2007-2012 Atlassian. All Rights Reserved.