Package org.simpleframework.xml.core
Class CompositeInlineList
- java.lang.Object
-
- org.simpleframework.xml.core.CompositeInlineList
-
class CompositeInlineList extends java.lang.Object implements Repeater
TheCompositeInlineList
object is used to convert an group of elements in to a collection of element entries. This is used when a containing element for a list is not required. It extracts the elements by matching elements to name of the type that the annotated field or method requires. This enables these element entries to exist as siblings to other objects within the object. One restriction is that theRoot
annotation for each of the types within the list must be the same.<entry attribute="one"> <text>example text value</text> </entry> <entry attribute="two"> <text>some other example</text> </entry> <entry attribute="three"> <text>yet another example</text> </entry>
For the above XML element list the elemententry
is contained within the list. Each entry element is thus deserialized as a root element and then inserted into the list. This enables lists to be composed from XML documents. For serialization the reverse is done, each element taken from the collection is written as a root element to the owning element to create the list. Entry objects do not need to be of the same type.- See Also:
Traverser
,ElementList
-
-
Field Summary
Fields Modifier and Type Field Description private Type
entry
This is the entry type for elements within the list.private CollectionFactory
factory
This factory is used to create a suitable collection list.private java.lang.String
name
This represents the name of the entry elements to write.private Traverser
root
This performs the traversal used for object serialization.private Type
type
This represents the actual method or field for the list.
-
Constructor Summary
Constructors Constructor Description CompositeInlineList(Context context, Type type, Type entry, java.lang.String name)
Constructor for theCompositeInlineList
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
read(InputNode node)
Thisread
method wll read the XML element list from the provided node and deserialize its children as entry types.private java.lang.Object
read(InputNode node, java.lang.Class expect)
Thisread
method will read the XML element from the provided node.java.lang.Object
read(InputNode node, java.lang.Object value)
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types.private java.lang.Object
read(InputNode node, java.util.Collection list)
Thisread
method wll read the XML element list from the provided node and deserialize its children as entry types.boolean
validate(InputNode node)
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types.void
write(OutputNode node, java.lang.Object source)
Thiswrite
method will write the specified object to the given XML element as as list entries.void
write(OutputNode node, java.util.Collection list)
Thiswrite
method will write the specified object to the given XML element as as list entries.
-
-
-
Field Detail
-
factory
private final CollectionFactory factory
This factory is used to create a suitable collection list.
-
root
private final Traverser root
This performs the traversal used for object serialization.
-
name
private final java.lang.String name
This represents the name of the entry elements to write.
-
entry
private final Type entry
This is the entry type for elements within the list.
-
type
private final Type type
This represents the actual method or field for the list.
-
-
Constructor Detail
-
CompositeInlineList
public CompositeInlineList(Context context, Type type, Type entry, java.lang.String name)
Constructor for theCompositeInlineList
object. This is given the list type and entry type to be used. The list type is theCollection
implementation that is used to collect the deserialized entry objects from the XML source.- Parameters:
context
- this is the context object used for serializationtype
- this is the collection type for the list usedentry
- the entry type to be stored within the listname
- this is the name of the entries used for this list
-
-
Method Detail
-
read
public java.lang.Object read(InputNode node) throws java.lang.Exception
Thisread
method wll read the XML element list from the provided node and deserialize its children as entry types. This will each entry type is deserialized as a root type, that is, itsRoot
annotation must be present and the name of the entry element must match that root element name.
-
read
public java.lang.Object read(InputNode node, java.lang.Object value) throws java.lang.Exception
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types. This will each entry type is deserialized as a root type, that is, itsRoot
annotation must be present and the name of the entry element must match that root element name.- Specified by:
read
in interfaceConverter
- Specified by:
read
in interfaceRepeater
- Parameters:
node
- this is the XML element that is to be deserializedvalue
- this is the value to read the objects in to- Returns:
- this returns the item to attach to the object contact
- Throws:
java.lang.Exception
- if a deserialized type cannot be instantiated
-
read
private java.lang.Object read(InputNode node, java.util.Collection list) throws java.lang.Exception
Thisread
method wll read the XML element list from the provided node and deserialize its children as entry types. This will each entry type is deserialized as a root type, that is, itsRoot
annotation must be present and the name of the entry element must match that root element name.- Parameters:
node
- this is the XML element that is to be deserializedlist
- this is the collection that is to be populated- Returns:
- this returns the item to attach to the object contact
- Throws:
java.lang.Exception
-
read
private java.lang.Object read(InputNode node, java.lang.Class expect) throws java.lang.Exception
Thisread
method will read the XML element from the provided node. This checks to ensure that the deserialized type is the same as the entry type provided. If the types are not the same then an exception is thrown. This is done to ensure each node in the collection contain the same root annotation.- Parameters:
node
- this is the XML element that is to be deserializedexpect
- this is the type expected of the deserialized type- Returns:
- this returns the item to attach to the object contact
- Throws:
java.lang.Exception
-
validate
public boolean validate(InputNode node) throws java.lang.Exception
Thisread
method will read the XML element list from the provided node and deserialize its children as entry types. This will each entry type is deserialized as a root type, that is, itsRoot
annotation must be present and the name of the entry element must match that root element name.
-
write
public void write(OutputNode node, java.lang.Object source) throws java.lang.Exception
Thiswrite
method will write the specified object to the given XML element as as list entries. Each entry within the given collection must be assignable from the annotated type specified within theElementList
annotation. Each entry is serialized as a root element, that is, itsRoot
annotation is used to extract the name.
-
write
public void write(OutputNode node, java.util.Collection list) throws java.lang.Exception
Thiswrite
method will write the specified object to the given XML element as as list entries. Each entry within the given collection must be assignable from the annotated type specified within theElementList
annotation. Each entry is serialized as a root element, that is, itsRoot
annotation is used to extract the name.- Parameters:
list
- this is the source collection to be serializednode
- this is the XML element container to be populated- Throws:
java.lang.Exception
-
-