Class DateTransform<T extends Date>

java.lang.Object
org.simpleframework.xml.transform.DateTransform<T>
All Implemented Interfaces:
Transform<T>

class DateTransform<T extends Date> extends Object implements Transform<T>
The DateTransform 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 the CycleStrategy object.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final DateFactory<T>
    This represents the constructor used for creating the date.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor for the DateTransform object.
  • Method Summary

    Modifier and Type
    Method
    Description
    read(String text)
    This method is used to convert the string value given to an appropriate representation.
    write(T date)
    This method is used to convert the provided value into an XML usable format.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • factory

      private final DateFactory<T extends Date> factory
      This represents the constructor used for creating the date.
  • Constructor Details

    • DateTransform

      public DateTransform(Class<T> type) throws Exception
      Constructor for the DateTransform 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:
      Exception
  • Method Details

    • read

      public T read(String text) throws 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.
      Specified by:
      read in interface Transform<T extends Date>
      Parameters:
      text - the string representation of the date value
      Returns:
      this returns an appropriate instanced to be used
      Throws:
      Exception
    • write

      public String write(T date) throws 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.
      Specified by:
      write in interface Transform<T extends Date>
      Parameters:
      date - this is the value to be converted to a string
      Returns:
      this is the string representation of the given date
      Throws:
      Exception