Class StringArrayTransform

java.lang.Object
org.simpleframework.xml.transform.StringArrayTransform
All Implemented Interfaces:
Transform<String[]>

class StringArrayTransform extends Object implements Transform<String[]>
The StringArrayTransform is used to transform string 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 String[] array;
    
 
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 Pattern
    Represents the pattern used to split the string values.
    private final String
    This is the token used to split the string into an array.
  • Constructor Summary

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

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

    • pattern

      private final Pattern pattern
      Represents the pattern used to split the string values.
    • token

      private final String token
      This is the token used to split the string into an array.
  • Constructor Details

    • StringArrayTransform

      public StringArrayTransform()
      Constructor for the StringArrayTransform object. This will create a transform that will split an array using a comma as the delimeter. In order to perform the split in a reasonably performant manner the pattern used is compiled.
    • StringArrayTransform

      public StringArrayTransform(String token)
      Constructor for the StringArrayTransform object. This will create a transform that will split an array using a specified regular expression pattern. To keep the performance of the transform reasonable the pattern used is compiled.
      Parameters:
      token - the pattern used to split the string values
  • Method Details

    • read

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

      private String[] read(String value, String token)
      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:
      value - this is the string representation of the value
      token - this is the token used to split the string
      Returns:
      this returns an appropriate instanced to be used
    • write

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

      private String write(String[] list, String token)
      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:
      list - this is the value to be converted to a string
      token - this is the token used to join the strings
      Returns:
      this is the string representation of the given value