Package org.simpleframework.xml.core
Class PrimitiveKey
java.lang.Object
org.simpleframework.xml.core.PrimitiveKey
- All Implemented Interfaces:
Converter
The
PrimitiveKey
is used to serialize a primitive key
to and from a node. If a key name is provided in the annotation
then this will serialize and deserialize that key with the given
name, if the key is an attribute, then it is written using the
provided name.
<entry key="one">example one</entry> <entry key="two">example two</entry> <entry key="three">example three</entry>Allowing the key to be written as either an XML attribute or an element enables a more flexible means for representing the key. Composite elements can not be used as attribute values as they do not serialize to a string. Primitive keys as elements can be maintained as references using the cycle strategy.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Context
This is the context used to support the serialization process.private final Entry
The entry object contains the details on how to write the key.private final PrimitiveFactory
The primitive factory used to resolve the primitive to a string.private final Primitive
The primitive converter used to read the key from the node.private final Style
This is the style used to style the XML elements for the key.private final Type
Represents the primitive type the key is serialized to and from. -
Constructor Summary
ConstructorsConstructorDescriptionPrimitiveKey
(Context context, Entry entry, Type type) Constructor for thePrimitiveKey
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.This 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
readAttribute
(InputNode node, String key) This method is used to read the key value from the node.private Object
readElement
(InputNode node, String key) 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
validateAttribute
(InputNode node, String key) This method is used to read the key value from the node.private boolean
validateElement
(InputNode node, String key) 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.private void
writeAttribute
(OutputNode node, Object item) This method is used to write the value to the specified node.private void
writeElement
(OutputNode node, Object item) This method is used to write the value to the specified node.
-
Field Details
-
factory
The primitive factory used to resolve the primitive to a string. -
context
This is the context used to support the serialization process. -
root
The primitive converter used to read the key from the node. -
style
This is the style used to style the XML elements for the key. -
entry
The entry object contains the details on how to write the key. -
type
Represents the primitive type the key is serialized to and from.
-
-
Constructor Details
-
PrimitiveKey
Constructor for thePrimitiveKey
object. This is used to create the key object which converts the map key to an instance of the key type. This can also resolve references.- Parameters:
context
- this is the context object used for serializationentry
- this is the entry object that describes entriestype
- this is the type that this converter deals with
-
-
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 an exception is thrown. -
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 an exception is thrown. -
readAttribute
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 an null is assumed and returned.- Parameters:
node
- this is the node to read the key value fromkey
- this is the name of the attribute used by the key- Returns:
- this returns the value deserialized from the node
- Throws:
Exception
-
readElement
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 element used by the key- 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 the node is considered as null and is valid. -
validateAttribute
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 the node is considered as null and is valid.- Parameters:
node
- this is the node to read the key value fromkey
- this is the name of the attribute used by the key- Returns:
- this returns the value deserialized from the node
- Throws:
Exception
-
validateElement
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 the node is considered as null and is valid.- Parameters:
node
- this is the node to read the key value fromkey
- this is the name of the element used by the key- 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 can be an attribute or an element depending on the annotation attribute values. This method will maintain references for serialized elements. -
writeElement
This method is used to write the value to the specified node. This will write the item as an element to the provided node, also this enables references to be used during serialization.- Parameters:
node
- this is the node that the value is written toitem
- this is the item that is to be written- Throws:
Exception
-
writeAttribute
This method is used to write the value to the specified node. This will write the item as an attribute to the provided node, the name of the attribute is taken from the annotation.- Parameters:
node
- this is the node that the value is written toitem
- this is the item that is to be written- 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
-