Class GregorianCalendarTransform
- java.lang.Object
-
- org.simpleframework.xml.transform.GregorianCalendarTransform
-
- All Implemented Interfaces:
Transform<java.util.GregorianCalendar>
class GregorianCalendarTransform extends java.lang.Object implements Transform<java.util.GregorianCalendar>
TheDateTransform
is used to transform calendar values to and from string representations, which will be inserted in the generated XML document as the value place holder. The value must be readable and writable in the same format. Fields and methods annotated with the XML attribute annotation will use this to persist and retrieve the value to and from the XML source.@Attribute private GregorianCalendar date;
As well as the XML attribute values using transforms, fields and methods annotated with the XML element annotation will use this. Aside from the obvious difference, the element annotation has an advantage over the attribute annotation in that it can maintain any references using theCycleStrategy
object.
-
-
Field Summary
Fields Modifier and Type Field Description private DateTransform
transform
This is the date transform used to parse and format dates.
-
Constructor Summary
Constructors Constructor Description GregorianCalendarTransform()
Constructor for theGregorianCalendarTransform
object.GregorianCalendarTransform(java.lang.Class type)
Constructor for theGregorianCalendarTransform
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.GregorianCalendar
read(java.lang.String date)
This method is used to convert the string value given to an appropriate representation.private java.util.GregorianCalendar
read(java.util.Date date)
This method is used to convert the string value given to an appropriate representation.java.lang.String
write(java.util.GregorianCalendar date)
This method is used to convert the provided value into an XML usable format.
-
-
-
Field Detail
-
transform
private final DateTransform transform
This is the date transform used to parse and format dates.
-
-
Constructor Detail
-
GregorianCalendarTransform
public GregorianCalendarTransform() throws java.lang.Exception
Constructor for theGregorianCalendarTransform
object. This is used to create a transform using a default date format pattern. The format chosen for the default date uses2007-05-02 12:22:10.000 GMT
like dates.- Throws:
java.lang.Exception
-
GregorianCalendarTransform
public GregorianCalendarTransform(java.lang.Class type) throws java.lang.Exception
Constructor for theGregorianCalendarTransform
object. This is used to create a transform using a default date format pattern. The format should typically contain enough information to create the date using a different locale or time zone between read and write operations.- Parameters:
type
- this is the type of date to be transformed- Throws:
java.lang.Exception
-
-
Method Detail
-
read
public java.util.GregorianCalendar read(java.lang.String date) throws java.lang.Exception
This method is used to convert the string value given to an appropriate representation. This is used when an object is being deserialized from the XML document and the value for the string representation is required.
-
read
private java.util.GregorianCalendar read(java.util.Date date) throws java.lang.Exception
This method is used to convert the string value given to an appropriate representation. This is used when an object is being deserialized from the XML document and the value for the string representation is required.- Parameters:
date
- the string representation of the date value- Returns:
- this returns an appropriate instanced to be used
- Throws:
java.lang.Exception
-
write
public java.lang.String write(java.util.GregorianCalendar date) throws java.lang.Exception
This method is used to convert the provided value into an XML usable format. This is used in the serialization process when there is a need to convert a field value in to a string so that that value can be written as a valid XML entity.
-
-