Class ArrayTransform
- java.lang.Object
-
- org.simpleframework.xml.transform.ArrayTransform
-
- All Implemented Interfaces:
Transform
class ArrayTransform extends java.lang.Object implements Transform
ThePrimitiveArrayTransform
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 theCycleStrategy
object.
-
-
Field Summary
Fields Modifier and Type Field Description private Transform
delegate
This is the transform that performs the individual transform.private java.lang.Class
entry
This is the entry type for the primitive array to be created.private StringArrayTransform
split
This transform is used to split the comma separated values.
-
Constructor Summary
Constructors Constructor Description ArrayTransform(Transform delegate, java.lang.Class entry)
Constructor for thePrimitiveArrayTransform
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
read(java.lang.String value)
This method is used to convert the string value given to an appropriate representation.private java.lang.Object
read(java.lang.String[] list, int length)
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.
-
-
-
Field Detail
-
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 java.lang.Class entry
This is the entry type for the primitive array to be created.
-
-
Constructor Detail
-
ArrayTransform
public ArrayTransform(Transform delegate, java.lang.Class entry)
Constructor for thePrimitiveArrayTransform
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 transformsentry
- 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.
-
read
private java.lang.Object read(java.lang.String[] 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 valuelength
- 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.
-
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
-
-