Package com.atlassian.jira.issue.customfields.impl

Class URLCFType

java.lang.Object

com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T,T>

com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType<String>

com.atlassian.jira.issue.customfields.impl.GenericTextCFType

com.atlassian.jira.issue.customfields.impl.URLCFType

All Implemented Interfaces:

ProjectImportableCustomField, CustomFieldType<String,String>, SortableCustomField<String>, TextCustomFieldType, ExportableCustomFieldType, RestAwareCustomFieldType, RestCustomFieldTypeOperations

public class URLCFType
extends GenericTextCFType
implements ExportableCustomFieldType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	URLCFType.Visitor<T>

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

AbstractCustomFieldType.VisitorBase<X>

Field Summary

Fields inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType

customFieldValuePersister, FIELD_TYPE_DATE, FIELD_TYPE_NUMBER, FIELD_TYPE_STRING, FIELD_TYPE_TEXT, genericConfigManager, log

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

DEFAULT_VALUE_TYPE, RESOURCE_PREVIEW

Constructor Summary

Constructors

Constructor	Description
URLCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, TextFieldCharacterLengthValidator textFieldCharacterLengthValidator, JiraAuthenticationContext jiraAuthenticationContext, ExternalLinkInNewWindow externalLinkInNewWindow)

Method Summary

Modifier and Type	Method	Description
Object	accept(AbstractCustomFieldType.VisitorBase visitor)
NonNullCustomFieldProvider	getNonNullCustomFieldProvider()	Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.
FieldExportParts	getRepresentationFromIssue(Issue issue, CustomFieldExportContext context)	Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.
String	getSingularObjectFromString(String string)	Returns a Singular Object, given the string value as passed by the presentation tier.
Map<String,Object>	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).

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

compare, getDatabaseType, getDbValueFromObject, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getObjectFromDbValue, getProjectImporter, getRestFieldOperation, getStringFromSingularObject, getValueFromCustomFieldParams

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

createValue, getChangelogValue, getDefaultValue, getJsonDefaultValue, getStringValueFromCustomFieldParams, getValueFromIssue, getValueFromIssue, remove, setDefaultValue, updateValue, validateFromParams

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

assertObjectImplementsType, availableForBulkEdit, getChangelogString, getConfigurationItemTypes, getDescription, getDescriptor, getI18nBean, getKey, getName, getRelatedIndexers, getVelocityParameters, init, isRenderable, valuesEqual

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, getCloneOptionConfiguration, getCloneValue, getIndexers, isUserInputRequiredForMove, requiresAdditionalParams

Methods inherited from interface com.atlassian.jira.issue.fields.rest.RestCustomFieldTypeOperations

getJsonDefaultValue

Constructor Details

URLCFType

public URLCFType(CustomFieldValuePersister customFieldValuePersister,
 GenericConfigManager genericConfigManager,
 TextFieldCharacterLengthValidator textFieldCharacterLengthValidator,
 JiraAuthenticationContext jiraAuthenticationContext,
 ExternalLinkInNewWindow externalLinkInNewWindow)

Method Details

getNonNullCustomFieldProvider

public NonNullCustomFieldProvider getNonNullCustomFieldProvider()

Description copied from interface: CustomFieldType

Returns an instance of NonNullCustomFieldProvider that Jira will use to optimize indexing performance.

Specified by:

getNonNullCustomFieldProvider in interface CustomFieldType<String,String>

getSingularObjectFromString

public String getSingularObjectFromString(String string)
                                   throws FieldValidationException

Description copied from interface: CustomFieldType

Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.

Specified by:

getSingularObjectFromString in interface CustomFieldType<String,String>

Overrides:

getSingularObjectFromString in class GenericTextCFType

Parameters:

string - the String

Returns:

singularObject instance

Throws:

FieldValidationException - if the string is an invalid representation of the Object.

accept

public Object accept(AbstractCustomFieldType.VisitorBase visitor)

Overrides:

accept in class GenericTextCFType

getRepresentationFromIssue

public FieldExportParts getRepresentationFromIssue(Issue issue,
 CustomFieldExportContext context)

Description copied from interface: ExportableCustomFieldType

Get the custom field representation of the issue, this object contains the column headers and values for each of the FieldExportPart.

Specified by:

getRepresentationFromIssue in interface ExportableCustomFieldType

Parameters:

issue - to get the representation for

context - which contains information such as the i18nHelper and field

Returns:

the exportable parts of this issue

getVelocityParameters

@Nonnull
public Map<String,Object> getVelocityParameters(Issue issue,
 CustomField field,
 FieldLayoutItem fieldLayoutItem)

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

Overrides:

getVelocityParameters in class AbstractCustomFieldType<String,String>

Parameters:

issue - The issue currently in context (Note: this will be null in cases like 'default value')

field - CustomField

fieldLayoutItem - FieldLayoutItem

Returns:

A Map of parameters to add to the velocity context, or an empty Map otherwise (never null)