Package com.atlassian.greenhopper.customfield.sprint

Class SprintCFType

java.lang.Object
com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Collection<Sprint>,Sprint>
com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint>
com.atlassian.greenhopper.customfield.sprint.SprintCFType
All Implemented Interfaces:
MetadataCFType, com.atlassian.jira.imports.project.customfield.ProjectImportableCustomField, com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>, com.atlassian.jira.issue.export.customfield.ExportableCustomFieldType, com.atlassian.jira.issue.fields.rest.RestAwareCustomFieldType, com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations
public class SprintCFType extends com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<Sprint> implements com.atlassian.jira.issue.export.customfield.ExportableCustomFieldType, MetadataCFType, com.atlassian.jira.issue.fields.rest.RestAwareCustomFieldType, com.atlassian.jira.imports.project.customfield.ProjectImportableCustomField, com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations
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

    Fields
    Modifier and Type
    Field
    Description
    static final CustomFieldMetadata
    CUSTOMFIELD_METADATA
    the meta-data needed to define the custom field in JIRA
    static final com.atlassian.jira.issue.fields.rest.FieldTypeInfo
    DEFAULT_FIELD_TYPE_INFO
     
    static final 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, RESOURCE_PREVIEW

  • Constructor Summary

    Constructors
    Constructor
    Description
    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, PermissionService permissionService, SprintRestSerializer sprintRestSerializer, com.atlassian.jira.config.FeatureManager featureManager, com.atlassian.jira.bc.issue.IssueService issueService, PermissionUsedToModifySprintAnalyticEventPublisher permissionUsedToModifySprintAnalyticEventPublisher, SprintRestFieldOperationsHandler sprintRestFieldOperationsHandler, JiraSoftwareFeatureService jiraSoftwareFeaturesService)
    Overriden, calls super constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Sprint
    convertDbValueToType(Object dbValue)
     
    Map<String,Object>
    convertEditValueToObjects(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.fields.CustomField field, List<String> inputValues)
     
    protected Object
    convertTypeToDbValue(Sprint sprint)
     
    String
    getChangelogString(com.atlassian.jira.issue.fields.CustomField field, Collection<Sprint> values)
     
    String
    getChangelogValue(com.atlassian.jira.issue.fields.CustomField field, Collection<Sprint> values)
     
    com.atlassian.jira.issue.customfields.CloneOptionConfiguration
    getCloneOptionConfiguration(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issueToClone)
     
    protected com.atlassian.jira.issue.customfields.persistence.PersistenceFieldType
    getDatabaseType()
     
    com.atlassian.jira.issue.fields.rest.FieldTypeInfo
    getFieldTypeInfo(com.atlassian.jira.issue.fields.rest.FieldTypeInfoContext fieldTypeInfoContext)
     
    com.atlassian.jira.issue.fields.rest.json.JsonData
    getJsonDefaultValue(com.atlassian.jira.issue.context.IssueContext issueCtx, com.atlassian.jira.issue.fields.CustomField field)
     
    com.atlassian.jira.issue.fields.rest.FieldJsonRepresentation
    getJsonFromIssue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue, boolean renderedVersionRequested, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem fieldLayoutItem)
     
    com.atlassian.jira.issue.fields.rest.json.JsonType
    getJsonSchema(com.atlassian.jira.issue.fields.CustomField customField)
     
    CustomFieldMetadata
    getMetadata()
     
    com.atlassian.jira.issue.customfields.vdi.NonNullCustomFieldProvider
    getNonNullCustomFieldProvider()
     
    com.atlassian.jira.imports.project.customfield.ProjectCustomFieldImporter
    getProjectImporter()
     
    com.atlassian.jira.issue.export.FieldExportParts
    getRepresentationFromIssue(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.export.customfield.CustomFieldExportContext context)
     
    com.atlassian.jira.issue.fields.rest.RestFieldOperationsHandler
    getRestFieldOperation(com.atlassian.jira.issue.fields.CustomField field)
     
    Sprint
    getSingularObjectFromString(String idAsString)
     
    String
    getStringFromSingularObject(Sprint sprint)
     
    Object
    getStringValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
     
    protected Comparator<Sprint>
    getTypeComparator()
     
    Collection<Sprint>
    getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
     
    Collection<Sprint>
    getValueFromIssue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue)
     
    Map<String,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()
     
    protected void
    parseAndValidateParams(Object idObj, com.atlassian.jira.util.ErrorCollection errorCollectionToAddTo, com.atlassian.jira.issue.fields.config.FieldConfig config)
     
    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(Collection<Sprint> v1, Collection<Sprint> v2)
     

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

    accept, convertDbObjectToTypes, convertTypesToDbObjects, createValue, getDefaultValue, getValueFromIssue, remove, setDefaultValue, updateValue

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

    assertObjectImplementsType, availableForBulkEdit, getConfigurationItemTypes, getDescription, getDescriptor, getI18nBean, getKey, getName, getVelocityParameters, init

    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

    areAllRequiredParametersPresent, getCloneValue, getIndexers, isUserInputRequiredForMove, requiresAdditionalParams

  • Field Details

    • 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

    • DEFAULT_FIELD_TYPE_INFO

      public static final com.atlassian.jira.issue.fields.rest.FieldTypeInfo DEFAULT_FIELD_TYPE_INFO

  • Constructor Details

  • Method Details

    • getSingularObjectFromString

      public Sprint getSingularObjectFromString(String idAsString) throws com.atlassian.jira.issue.customfields.impl.FieldValidationException
      Specified by:
      getSingularObjectFromString in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>
      Throws:
      com.atlassian.jira.issue.customfields.impl.FieldValidationException

    • getStringFromSingularObject

      public String getStringFromSingularObject(Sprint sprint)
      Specified by:
      getStringFromSingularObject in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<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)
      Specified by:
      validateFromParams in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>

    • parseAndValidateParams

      protected void parseAndValidateParams(Object idObj, com.atlassian.jira.util.ErrorCollection errorCollectionToAddTo, com.atlassian.jira.issue.fields.config.FieldConfig config)

    • getValueFromCustomFieldParams

      public Collection<Sprint> 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<Collection<Sprint>,Sprint>
      Throws:
      com.atlassian.jira.issue.customfields.impl.FieldValidationException

    • getStringValueFromCustomFieldParams

      public Object getStringValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams parameters)
      Specified by:
      getStringValueFromCustomFieldParams in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>

    • getVelocityParameters

      public Map<String,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<Collection<Sprint>,Sprint>
      Overrides:
      getVelocityParameters in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Collection<Sprint>,Sprint>

    • convertEditValueToObjects

      public Map<String,Object> convertEditValueToObjects(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.fields.CustomField field, @Nullable List<String> inputValues)

    • getValueFromIssue

      public 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<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<Collection<Sprint>,Sprint>
      Overrides:
      isRenderable in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Collection<Sprint>,Sprint>

    • getTypeComparator

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

    • convertTypeToDbValue

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

    • convertDbValueToType

      protected Sprint convertDbValueToType(@Nullable 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(Collection<Sprint> v1, Collection<Sprint> v2)
      Specified by:
      valuesEqual in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>
      Overrides:
      valuesEqual in class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<Collection<Sprint>,Sprint>

    • getChangelogValue

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

    • getChangelogString

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

    • getMetadata

      public CustomFieldMetadata getMetadata()
      Specified by:
      getMetadata in interface MetadataCFType

    • getFieldTypeInfo

      public com.atlassian.jira.issue.fields.rest.FieldTypeInfo getFieldTypeInfo(com.atlassian.jira.issue.fields.rest.FieldTypeInfoContext fieldTypeInfoContext)
      Specified by:
      getFieldTypeInfo in interface com.atlassian.jira.issue.fields.rest.RestAwareCustomFieldType

    • getJsonSchema

      public com.atlassian.jira.issue.fields.rest.json.JsonType getJsonSchema(com.atlassian.jira.issue.fields.CustomField customField)
      Specified by:
      getJsonSchema in interface com.atlassian.jira.issue.fields.rest.RestAwareCustomFieldType

    • getJsonFromIssue

      public com.atlassian.jira.issue.fields.rest.FieldJsonRepresentation getJsonFromIssue(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issue, boolean renderedVersionRequested, @Nullable com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem fieldLayoutItem)
      Specified by:
      getJsonFromIssue in interface com.atlassian.jira.issue.fields.rest.RestAwareCustomFieldType

    • getProjectImporter

      public com.atlassian.jira.imports.project.customfield.ProjectCustomFieldImporter getProjectImporter()
      Specified by:
      getProjectImporter in interface com.atlassian.jira.imports.project.customfield.ProjectImportableCustomField

    • getCloneOptionConfiguration

      public com.atlassian.jira.issue.customfields.CloneOptionConfiguration getCloneOptionConfiguration(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.Issue issueToClone)
      Specified by:
      getCloneOptionConfiguration in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>

    • getRepresentationFromIssue

      public com.atlassian.jira.issue.export.FieldExportParts getRepresentationFromIssue(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.export.customfield.CustomFieldExportContext context)
      Specified by:
      getRepresentationFromIssue in interface com.atlassian.jira.issue.export.customfield.ExportableCustomFieldType

    • getRestFieldOperation

      public com.atlassian.jira.issue.fields.rest.RestFieldOperationsHandler getRestFieldOperation(com.atlassian.jira.issue.fields.CustomField field)
      Specified by:
      getRestFieldOperation in interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations

    • getJsonDefaultValue

      public com.atlassian.jira.issue.fields.rest.json.JsonData getJsonDefaultValue(com.atlassian.jira.issue.context.IssueContext issueCtx, com.atlassian.jira.issue.fields.CustomField field)
      Specified by:
      getJsonDefaultValue in interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations

    • getNonNullCustomFieldProvider

      public com.atlassian.jira.issue.customfields.vdi.NonNullCustomFieldProvider getNonNullCustomFieldProvider()
      Specified by:
      getNonNullCustomFieldProvider in interface com.atlassian.jira.issue.customfields.CustomFieldType<Collection<Sprint>,Sprint>