Class StringArrayTransform
- java.lang.Object
-
- org.simpleframework.xml.transform.StringArrayTransform
-
- All Implemented Interfaces:
Transform<java.lang.String[]>
class StringArrayTransform extends java.lang.Object implements Transform<java.lang.String[]>
TheStringArrayTransform
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 theCycleStrategy
object.
-
-
Constructor Summary
Constructors Constructor Description StringArrayTransform()
Constructor for theStringArrayTransform
object.StringArrayTransform(java.lang.String token)
Constructor for theStringArrayTransform
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
read(java.lang.String value)
This method is used to convert the string value given to an appropriate representation.private java.lang.String[]
read(java.lang.String value, java.lang.String token)
This method is used to convert the string value given to an appropriate representation.java.lang.String
write(java.lang.String[] list)
This method is used to convert the provided value into an XML usable format.private java.lang.String
write(java.lang.String[] list, java.lang.String token)
This method is used to convert the provided value into an XML usable format.
-
-
-
Constructor Detail
-
StringArrayTransform
public StringArrayTransform()
Constructor for theStringArrayTransform
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(java.lang.String token)
Constructor for theStringArrayTransform
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 Detail
-
read
public java.lang.String[] read(java.lang.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.
-
read
private java.lang.String[] read(java.lang.String value, java.lang.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 valuetoken
- this is the token used to split the string- Returns:
- this returns an appropriate instanced to be used
-
write
public java.lang.String write(java.lang.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.
-
write
private java.lang.String write(java.lang.String[] list, java.lang.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 stringtoken
- this is the token used to join the strings- Returns:
- this is the string representation of the given value
-
-