Class GregorianCalendarTransform

  • All Implemented Interfaces:
    Transform<java.util.GregorianCalendar>

    class GregorianCalendarTransform
    extends java.lang.Object
    implements Transform<java.util.GregorianCalendar>
    The DateTransform 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 the CycleStrategy object.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DateTransform transform
      This is the date transform used to parse and format dates.
    • 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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 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 the GregorianCalendarTransform object. This is used to create a transform using a default date format pattern. The format chosen for the default date uses 2007-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 the GregorianCalendarTransform 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.
        Specified by:
        read in interface Transform<java.util.GregorianCalendar>
        Parameters:
        date - the string representation of the date value
        Returns:
        this returns an appropriate instanced to be used
        Throws:
        java.lang.Exception
      • 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.
        Specified by:
        write in interface Transform<java.util.GregorianCalendar>
        Parameters:
        date - this is the value to be converted to a string
        Returns:
        this is the string representation of the given date
        Throws:
        java.lang.Exception