Package org.simpleframework.xml.core
Class CompositeKey
java.lang.Object
org.simpleframework.xml.core.CompositeKey
- All Implemented Interfaces:
Converter
The
CompositeKey
object is used to convert an object
to an from an XML element. This accepts only composite objects and
will throw an exception if the ElementMap
annotation
is configured to have an attribute key. If a key name is given for
the annotation then this will act as a parent element to the
resulting XML element for the composite object.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Context
This is the context used to support the serialization process.private final Entry
This is the entry object used to provide configuration details.private final Traverser
This is the traverser used to read and write the composite key.private final Style
This is the style used to style the names used for the XML.private final Type
This represents the type of object the key is written as. -
Constructor Summary
ConstructorsConstructorDescriptionCompositeKey
(Context context, Entry entry, Type type) Constructor for theCompositeKey
object. -
Method Summary
Modifier and TypeMethodDescriptionThis method is used to read the key value from the node.This method is used to read the key value from the node.private Object
This method is used to read the key value from the node.boolean
This method is used to read the key value from the node.private boolean
This method is used to read the key value from the node.void
write
(OutputNode node, Object item) This method is used to write the value to the specified node.
-
Field Details
-
context
This is the context used to support the serialization process. -
root
This is the traverser used to read and write the composite key. -
style
This is the style used to style the names used for the XML. -
entry
This is the entry object used to provide configuration details. -
type
This represents the type of object the key is written as.
-
-
Constructor Details
-
CompositeKey
Constructor for theCompositeKey
object. This will create an object capable of reading an writing composite keys from an XML element. This also allows a parent element to be created to wrap the key object if desired.- Parameters:
context
- this is the root context for the serializationentry
- this is the entry object used for configurationtype
- this is the type of object the key represents- Throws:
Exception
-
-
Method Details
-
read
This method is used to read the key value from the node. The value read from the node is resolved using the template filter. If the key value can not be found according to the annotation attributes then null is assumed and returned. -
read
This method is used to read the key value from the node. The value read from the node is resolved using the template filter. If the key value can not be found according to the annotation attributes then null is assumed and returned. -
read
This method is used to read the key value from the node. The value read from the node is resolved using the template filter. If the key value can not be found according to the annotation attributes then null is assumed and returned.- Parameters:
node
- this is the node to read the key value fromkey
- this is the name of the key wrapper XML element- Returns:
- this returns the value deserialized from the node
- Throws:
Exception
-
validate
This method is used to read the key value from the node. The value read from the node is resolved using the template filter. If the key value can not be found according to the annotation attributes then null is assumed and the node is valid. -
validate
This method is used to read the key value from the node. The value read from the node is resolved using the template filter. If the key value can not be found according to the annotation attributes then null is assumed and the node is valid.- Parameters:
node
- this is the node to read the key value fromkey
- this is the name of the key wrapper XML element- Returns:
- this returns the value deserialized from the node
- Throws:
Exception
-
write
This method is used to write the value to the specified node. The value written to the node must be a composite object and if the element map annotation is configured to have a key attribute then this method will throw an exception.
-