Class DateTransform<T extends java.util.Date>
- java.lang.Object
-
- org.simpleframework.xml.transform.DateTransform<T>
-
- All Implemented Interfaces:
Transform<T>
class DateTransform<T extends java.util.Date> extends java.lang.Object implements Transform<T>
TheDateTransform
object is used to transform date 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 Date 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 DateFactory<T>
factory
This represents the constructor used for creating the date.
-
Constructor Summary
Constructors Constructor Description DateTransform(java.lang.Class<T> type)
Constructor for theDateTransform
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description T
read(java.lang.String text)
This method is used to convert the string value given to an appropriate representation.java.lang.String
write(T date)
This method is used to convert the provided value into an XML usable format.
-
-
-
Field Detail
-
factory
private final DateFactory<T extends java.util.Date> factory
This represents the constructor used for creating the date.
-
-
Constructor Detail
-
DateTransform
public DateTransform(java.lang.Class<T> type) throws java.lang.Exception
Constructor for theDateTransform
object. This is used to create a transform using a specified date format. 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 created by this- Throws:
java.lang.Exception
-
-
Method Detail
-
read
public T read(java.lang.String text) 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.
-
write
public java.lang.String write(T 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.
-
-