Conversion<java.lang.String,T>
, FormattedConversion<java.text.SimpleDateFormat>
public class CalendarConversion extends ObjectConversion<java.util.Calendar> implements FormattedConversion<java.text.SimpleDateFormat>
Calendar
and vice versa.
This class supports multiple date formats. For example, you can define conversions from dates represented by different Strings such as "2001/05/02 and Dec/2013".
The reverse conversion from a Calendar to String (in revert(Calendar)
will return a formatted String using the date pattern provided in this class constructor
The date patterns must follows the pattern rules of SimpleDateFormat
SimpleDateFormat
Constructor | Description |
---|---|
CalendarConversion(java.lang.String... dateFormats) |
Defines a conversion from String to
Calendar using a sequence of acceptable date patterns. |
CalendarConversion(java.util.Calendar valueIfStringIsNull,
java.lang.String valueIfObjectIsNull,
java.lang.String... dateFormats) |
Defines a conversion from String to
Calendar using a sequence of acceptable date patterns. |
Modifier and Type | Method | Description |
---|---|---|
protected java.util.Calendar |
fromString(java.lang.String input) |
Converts a formatted date String to an instance of Calendar.
|
java.text.SimpleDateFormat[] |
getFormatterObjects() |
Returns the formatter objects
|
java.lang.String |
revert(java.util.Calendar input) |
Converts Calendar to a formatted date String.
|
getValueOnNullInput, getValueOnNullOutput, setValueOnNullInput, setValueOnNullOutput
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
execute, fromInput, getValueIfObjectIsNull, getValueIfStringIsNull, setValueIfObjectIsNull, setValueIfStringIsNull, undo
public CalendarConversion(java.util.Calendar valueIfStringIsNull, java.lang.String valueIfObjectIsNull, java.lang.String... dateFormats)
Calendar
using a sequence of acceptable date patterns.
This constructor assumes the output of a conversion should be null when input is nullvalueIfStringIsNull
- default Calendar value to be returned when the input String is null. Used when ObjectConversion.execute(String)
is invoked.valueIfObjectIsNull
- default String value to be returned when a Calendar input is null. Used when revert(Calendar)
is invoked.dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Calendar into a String in revert(Calendar)
.public CalendarConversion(java.lang.String... dateFormats)
Calendar
using a sequence of acceptable date patterns.
This constructor assumes the output of a conversion should be null when input is nulldateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Calendar into a String in revert(Calendar)
.public java.lang.String revert(java.util.Calendar input)
The pattern used to generate the formatted date is the first date pattern provided in the constructor of this class
revert
in interface Conversion<java.lang.String,T>
revert
in class ObjectConversion<java.util.Calendar>
input
- the Calendar to be converted to a StringObjectConversion.getValueIfObjectIsNull()
if the Calendar parameter is null.protected java.util.Calendar fromString(java.lang.String input)
The pattern in the formatted date must match one of the date patterns provided in the constructor of this class.
fromString
in class ObjectConversion<java.util.Calendar>
input
- the String containing a formatted date which must be converted to a CalendarObjectConversion.getValueIfStringIsNull()
if the String input is null.public java.text.SimpleDateFormat[] getFormatterObjects()
FormattedConversion
getFormatterObjects
in interface FormattedConversion<java.text.SimpleDateFormat>