Class CharacterArrayTransform

  • All Implemented Interfaces:
    Transform

    class CharacterArrayTransform
    extends java.lang.Object
    implements Transform
    The CharacterArrayTransform is used to transform text 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 char[] text;
        
     
    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 java.lang.Class entry
      This is the entry type for the primitive array to be created.
    • Constructor Summary

      Constructors 
      Constructor Description
      CharacterArrayTransform​(java.lang.Class entry)
      Constructor for the PrimitiveArrayTransform object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private java.lang.Object read​(char[] list, int length)
      This method is used to convert the string value given to an appropriate representation.
      java.lang.Object read​(java.lang.String value)
      This method is used to convert the string value given to an appropriate representation.
      java.lang.String write​(java.lang.Object value)
      This method is used to convert the provided value into an XML usable format.
      private java.lang.String write​(java.lang.Object value, int length)
      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

      • entry

        private final java.lang.Class entry
        This is the entry type for the primitive array to be created.
    • Constructor Detail

      • CharacterArrayTransform

        public CharacterArrayTransform​(java.lang.Class entry)
        Constructor for the PrimitiveArrayTransform object. This is used to create a transform that will create primitive arrays and populate the values of the array with values from a comma separated list of individual values for the entry type.
        Parameters:
        entry - this is the entry component type for the array
    • Method Detail

      • read

        public java.lang.Object read​(java.lang.String value)
                              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
        Parameters:
        value - this is the string representation of the value
        Returns:
        this returns an appropriate instanced to be used
        Throws:
        java.lang.Exception
      • read

        private java.lang.Object read​(char[] list,
                                      int length)
                               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:
        list - this is the string representation of the value
        length - this is the number of string values to use
        Returns:
        this returns an appropriate instanced to be used
        Throws:
        java.lang.Exception
      • write

        public java.lang.String write​(java.lang.Object value)
                               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
        Parameters:
        value - this is the value to be converted to a string
        Returns:
        this is the string representation of the given value
        Throws:
        java.lang.Exception
      • write

        private java.lang.String write​(java.lang.Object value,
                                       int length)
                                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.
        Parameters:
        value - this is the value to be converted to a string
        Returns:
        this is the string representation of the given value
        Throws:
        java.lang.Exception