Package org.simpleframework.xml.transform

Class ArrayTransform

java.lang.Object
org.simpleframework.xml.transform.ArrayTransform
All Implemented Interfaces:
Transform
class ArrayTransform extends Object implements Transform
The PrimitiveArrayTransform is used to transform arrays 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 int[] 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 final Transform
    delegate
    This is the transform that performs the individual transform.
    private final Class
    entry
    This is the entry type for the primitive array to be created.
    private final StringArrayTransform
    split
    This transform is used to split the comma separated values.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArrayTransform(Transform delegate, Class entry)
    Constructor for the PrimitiveArrayTransform object.

  • Method Summary

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

    • split

      private final StringArrayTransform split
      This transform is used to split the comma separated values.

    • delegate

      private final Transform delegate
      This is the transform that performs the individual transform.

    • entry

      private final Class entry
      This is the entry type for the primitive array to be created.

  • Constructor Details

    • ArrayTransform

      public ArrayTransform(Transform delegate, 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 individula values for the entry type.
      Parameters:
      delegate - this is used to perform individual transforms
      entry - this is the entry component type for the array

  • Method Details

    • read

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

    • read

      private Object read(String[] list, int length) 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.
      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:
      Exception

    • write

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

    • write

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