com.guiseframework.converter
Class CalendarStringLiteralConverter

java.lang.Object
  extended by com.globalmentor.beans.BoundPropertyObject
      extended by com.guiseframework.event.GuiseBoundPropertyObject
          extended by com.guiseframework.converter.AbstractConverter<V,java.lang.String>
              extended by com.guiseframework.converter.AbstractDateStringLiteralConverter<java.util.Calendar>
                  extended by com.guiseframework.converter.CalendarStringLiteralConverter
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Converter<java.util.Calendar,java.lang.String>

public class CalendarStringLiteralConverter
extends AbstractDateStringLiteralConverter<java.util.Calendar>

An object that can convert a calendar from and to a string.

Author:
Garret Wilson

Field Summary
 
Fields inherited from class com.globalmentor.beans.BoundPropertyObject
NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS
 
Fields inherited from interface com.guiseframework.converter.Converter
INVALID_VALUE_MESSAGE_PROPERTY
 
Constructor Summary
CalendarStringLiteralConverter(DateStringLiteralStyle dateStyle)
          Date style constructor with no time style.
CalendarStringLiteralConverter(DateStringLiteralStyle dateStyle, TimeStringLiteralStyle timeStyle)
          Date style and time style constructor.
 
Method Summary
 java.util.Calendar convertLiteral(java.lang.String literal)
          Converts a literal representation of a value from the lexical space into a value in the value space.
 java.lang.String convertValue(java.util.Calendar value)
          Converts a value from the value space to a literal value in the lexical space.
 
Methods inherited from class com.guiseframework.converter.AbstractDateStringLiteralConverter
convertDateLiteral, convertDateValue, createDateFormat, getDateFormat, getDateStyle, getTimeStyle
 
Methods inherited from class com.guiseframework.converter.AbstractConverter
getInvalidValueMessage, isEquivalent, isValidLiteral, setInvalidValueMessage
 
Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject
getSession
 
Methods inherited from class com.globalmentor.beans.BoundPropertyObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.guiseframework.converter.Converter
getSession
 
Methods inherited from interface com.globalmentor.beans.PropertyBindable
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
 

Constructor Detail

CalendarStringLiteralConverter

public CalendarStringLiteralConverter(DateStringLiteralStyle dateStyle)
Date style constructor with no time style.

Parameters:
dateStyle - The date representation style, or null if the date should not be represented.
Throws:
java.lang.NullPointerException - if the given date style is null.

CalendarStringLiteralConverter

public CalendarStringLiteralConverter(DateStringLiteralStyle dateStyle,
                                      TimeStringLiteralStyle timeStyle)
Date style and time style constructor.

Parameters:
dateStyle - The date representation style, or null if the date should not be represented.
timeStyle - The time representation style, or null if the time should not be represented.
Throws:
java.lang.NullPointerException - if both the given date style and time style are null.
Method Detail

convertValue

public java.lang.String convertValue(java.util.Calendar value)
                              throws ConversionException
Converts a value from the value space to a literal value in the lexical space. This implementation converts the value using the date format object. This implementation synchronizes on the DateFormat instance.

Parameters:
value - The value in the value space to convert.
Returns:
The converted value in the lexical space, or null if the given literal is null.
Throws:
ConversionException - if the value cannot be converted.
See Also:
AbstractDateStringLiteralConverter.getDateFormat()

convertLiteral

public java.util.Calendar convertLiteral(java.lang.String literal)
                                  throws ConversionException
Converts a literal representation of a value from the lexical space into a value in the value space. This implementation converts the empty string to a null value.

Parameters:
literal - The literal value in the lexical space to convert.
Returns:
The converted value in the value space, or null if the given literal is null.
Throws:
ConversionException - if the literal value cannot be converted.


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.