com.atlassian.jira.issue.customfields.impl
Class DateTimeCFType

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
      extended by com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
          extended by com.atlassian.jira.issue.customfields.impl.DateTimeCFType
All Implemented Interfaces:
ProjectImportableCustomField, CustomFieldType, SortableCustomField<java.util.Date>, DateField

public class DateTimeCFType
extends AbstractSingleFieldType
implements SortableCustomField<java.util.Date>, ProjectImportableCustomField, DateField


Nested Class Summary
static interface DateTimeCFType.Visitor<T>
           
 
Nested classes/interfaces inherited from class com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType
AbstractCustomFieldType.VisitorBase<T>
 
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
 
Constructor Summary
DateTimeCFType(CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
           
 int compare(java.util.Date v1, java.util.Date v2, FieldConfig fieldConfig)
          Compares the two custom field objects.
protected  PersistenceFieldType getDatabaseType()
          Type of database field needed to store this field.
protected  java.lang.Object getDbValueFromObject(java.lang.Object customFieldObject)
          Returns the database representation of the Java object as stored for that CustomField.
 java.lang.Object getDefaultValue(FieldConfig fieldConfig)
          Retrieves the Object representing the default CustomField value for the Custom Field.
 java.lang.String getNow()
           
protected  java.lang.Object getObjectFromDbValue(java.lang.Object databaseValue)
          Returns the Domain Object or GenericValue object representing the given Custom Field value as stored in the database
 ProjectCustomFieldImporter getProjectImporter()
          Returns the object that will perform the actual project import functions for the custom field type.
 java.lang.Object getSingularObjectFromString(java.lang.String string)
          Returns a Singular Object, given the string value as passed by the presentation tier.
 java.lang.String getStringFromSingularObject(java.lang.Object customFieldObject)
          Returns the String representation of a single value within the CustomFieldType.
 java.util.Map<java.lang.String,java.lang.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).
 boolean isUseNow(java.util.Date date)
           
 boolean isUseNow(FieldConfig fieldConfig)
           
 
Methods inherited from class com.atlassian.jira.issue.customfields.impl.AbstractSingleFieldType
createValue, getChangelogValue, getStringValueFromCustomFieldParams, getValueFromCustomFieldParams, 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
 

Constructor Detail

DateTimeCFType

public DateTimeCFType(CustomFieldValuePersister customFieldValuePersister,
                      GenericConfigManager genericConfigManager,
                      JiraAuthenticationContext authenticationContext)
Method Detail

getDatabaseType

protected PersistenceFieldType getDatabaseType()
Description copied from class: AbstractSingleFieldType
Type of database field needed to store this field.

Specified by:
getDatabaseType in class AbstractSingleFieldType
Returns:
One of the predefined PersistenceFieldType types.

getDbValueFromObject

protected java.lang.Object getDbValueFromObject(java.lang.Object customFieldObject)
Description copied from class: AbstractSingleFieldType
Returns the database representation of the Java object as stored for that CustomField. (eg. ProjectId if the Value represents a project)

Specified by:
getDbValueFromObject in class AbstractSingleFieldType
Returns:
String, Double or Date

getObjectFromDbValue

protected java.lang.Object getObjectFromDbValue(java.lang.Object databaseValue)
                                         throws FieldValidationException
Description copied from class: AbstractSingleFieldType
Returns the Domain Object or GenericValue object representing the given Custom Field value as stored in the database

Specified by:
getObjectFromDbValue in class AbstractSingleFieldType
Parameters:
databaseValue - - String, Double or Date objects
Returns:
Domain object or GenericValue
Throws:
FieldValidationException

getStringFromSingularObject

public java.lang.String getStringFromSingularObject(java.lang.Object customFieldObject)
Description copied from interface: CustomFieldType
Returns the String representation of a single value within the CustomFieldType. This is the value that will is passed to the presentation tier for editing. For single CustomFieldTypes the Singular Object is the same as a Transport Object. However, for multi-dimensional CustomFieldTypes, the Singular Object is the Object contained within the Collection or CustomFieldParams

Specified by:
getStringFromSingularObject in interface CustomFieldType
Parameters:
customFieldObject - the object
Returns:
String representation of the Object

getSingularObjectFromString

public java.lang.Object getSingularObjectFromString(java.lang.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
Parameters:
string - the String
Returns:
singularObject instance
Throws:
FieldValidationException - if the string is an invalid representation of the Object.

compare

public int compare(java.util.Date v1,
                   java.util.Date v2,
                   FieldConfig fieldConfig)
Description copied from interface: SortableCustomField
Compares the two custom field objects.

Specified by:
compare in interface SortableCustomField<java.util.Date>
Parameters:
v1 - Never null
v2 - Never null
Returns:
0, 1 or -1

getDefaultValue

public java.lang.Object getDefaultValue(FieldConfig fieldConfig)
Description copied from interface: CustomFieldType
Retrieves the Object representing the default CustomField value for the Custom Field. See CustomFieldType.getValueFromCustomFieldParams(com.atlassian.jira.issue.customfields.view.CustomFieldParams) for more detailed notes.

Specified by:
getDefaultValue in interface CustomFieldType
Overrides:
getDefaultValue in class AbstractSingleFieldType
Parameters:
fieldConfig - CustomField for default value
Returns:
Transport Object matching the Object parameter of CustomFieldType.createValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object), CustomFieldType.updateValue(com.atlassian.jira.issue.fields.CustomField, com.atlassian.jira.issue.Issue, java.lang.Object)

isUseNow

public boolean isUseNow(java.util.Date date)

isUseNow

public boolean isUseNow(FieldConfig fieldConfig)

getNow

public java.lang.String getNow()

getVelocityParameters

public java.util.Map<java.lang.String,java.lang.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
Overrides:
getVelocityParameters in class AbstractCustomFieldType
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)

getProjectImporter

public ProjectCustomFieldImporter getProjectImporter()
Description copied from interface: ProjectImportableCustomField
Returns the object that will perform the actual project import functions for the custom field type.

Specified by:
getProjectImporter in interface ProjectImportableCustomField
Returns:
the object that will perform the actual project import functions for the custom field type.

accept

public java.lang.Object accept(AbstractCustomFieldType.VisitorBase visitor)
Overrides:
accept in class AbstractSingleFieldType


Copyright © 2002-2010 Atlassian. All Rights Reserved.