Package org.simpleframework.xml.core
Class PrimitiveArray
java.lang.Object
org.simpleframework.xml.core.PrimitiveArray
- All Implemented Interfaces:
Converter
The
PrimitiveArray
object is used to convert a list of
elements to an array of object entries. This in effect performs a
serialization and deserialization of primitive elements for the
array object. On serialization each primitive type must be checked
against the array component type so that it is serialized in a form
that can be deserialized dynamically.
<array> <entry>example text one</entry> <entry>example text two</entry> <entry>example text three</entry> </array>For the above XML element list the element
entry
is
contained within the array. Each entry element is deserialized as
a from a parent XML element, which is specified in the annotation.
For serialization the reverse is done, each element taken from the
array is written into an element created from the parent element.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Type
This is the type of object that will be held in the list.private final ArrayFactory
This factory is used to create an array for the contact.private final String
This is the name that each array element is wrapped with.private final Primitive
This performs the serialization of the primitive element.private final Type
This represents the actual field or method for the array. -
Constructor Summary
ConstructorsConstructorDescriptionPrimitiveArray
(Context context, Type type, Type entry, String parent) Constructor for thePrimitiveArray
object. -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
isOverridden
(OutputNode node, Object value) This is used to determine whether the specified value has been overridden by the strategy.Thisread
method will read the XML element list from the provided node and deserialize its children as entry types.Thisread
method will read the XML element list from the provided node and deserialize its children as entry types.boolean
Thisvalidate
method will validate the XML element list from the provided node and validate its children as entry types.private boolean
Thisvalidate
method will validate the XML element list from the provided node and validate its children as entry types.void
write
(OutputNode node, Object source) Thiswrite
method will write the specified object to the given XML element as as array entries.private void
write
(OutputNode node, Object source, int index) Thiswrite
method will write the specified object to the given XML element as as array entries.
-
Field Details
-
factory
This factory is used to create an array for the contact. -
root
This performs the serialization of the primitive element. -
parent
This is the name that each array element is wrapped with. -
entry
This is the type of object that will be held in the list. -
type
This represents the actual field or method for the array.
-
-
Constructor Details
-
PrimitiveArray
Constructor for thePrimitiveArray
object. This is given the array type for the contact that is to be converted. An array of the specified type is used to hold the deserialized elements and will be the same length as the number of elements.- Parameters:
context
- this is the context object used for serializationtype
- this is the actual field type from the schemaentry
- the entry type to be stored within the arrayparent
- this is the name to wrap the array element with
-
-
Method Details
-
read
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types. This will deserialize each entry type as a primitive value. In order to do this the parent string provided forms the element. -
read
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types. This will deserialize each entry type as a primitive value. In order to do this the parent string provided forms the element. -
validate
Thisvalidate
method will validate the XML element list from the provided node and validate its children as entry types. This will validate each entry type as a primitive value. In order to do this the parent string provided forms the element. -
validate
Thisvalidate
method will validate the XML element list from the provided node and validate its children as entry types. This will validate each entry type as a primitive value. In order to do this the parent string provided forms the element.- Parameters:
node
- this is the XML element that is to be validatedtype
- this is the array type used to create the array- Returns:
- true if the element matches the XML schema class given
- Throws:
Exception
-
write
Thiswrite
method will write the specified object to the given XML element as as array entries. Each entry within the given array must be assignable to the array component type. This will deserialize each entry type as a primitive value. In order to do this the parent string provided forms the element. -
write
Thiswrite
method will write the specified object to the given XML element as as array entries. Each entry within the given array must be assignable to the array component type. This will deserialize each entry type as a primitive value. In order to do this the parent string provided forms the element.- Parameters:
node
- this is the XML element container to be populatedsource
- this is the source object array to be serializedindex
- this is the position in the array to set the item- Throws:
Exception
-
isOverridden
This is used to determine whether the specified value has been overridden by the strategy. If the item has been overridden then no more serialization is require for that value, this is effectively telling the serialization process to stop writing.- Parameters:
node
- the node that a potential override is written tovalue
- this is the object instance to be serialized- Returns:
- returns true if the strategy overrides the object
- Throws:
Exception
-