- clear() - Method in class simple.xml.util.Resolver
-
This is used to clear all matches from the set.
- Commit - Annotation Type in simple.xml.load
-
The Commit
annotation is used to mark a method within
a serializable object that requires a callback from the persister
once the deserialization completes.
- commit() - Method in interface simple.xml.stream.OutputNode
-
The commit
method is used flush and commit any
child nodes that have been created by this node.
- Complete - Annotation Type in simple.xml.load
-
The Complete
annotation is used to mark a method that
requires a callback from the persister once the serialization of
the object has completed.
- CycleException - Exception in simple.xml.graph
-
The CycleException
is thrown when an invalid cycle
is found when deserializing an object from an XML document.
- CycleException(String, Object...) - Constructor for exception simple.xml.graph.CycleException
-
Constructor for the CycleException
object.
- CycleException(Throwable, String, Object...) - Constructor for exception simple.xml.graph.CycleException
-
Constructor for the CycleException
object.
- CycleStrategy - Class in simple.xml.graph
-
The CycleStrategy
represents a strategy that is used
to augment the deserialization and serialization process such that
cycles in an object graph can be supported.
- CycleStrategy() - Constructor for class simple.xml.graph.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String) - Constructor for class simple.xml.graph.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String, String) - Constructor for class simple.xml.graph.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String, String, String) - Constructor for class simple.xml.graph.CycleStrategy
-
Constructor for the CycleStrategy
object.
- get(String) - Method in interface simple.xml.stream.NodeMap
-
This is used to acquire the Node
mapped to the
given name.
- get(String) - Method in class simple.xml.util.Dictionary
-
This is used to acquire an Entry
from the set by
its name.
- getAttribute(String) - Method in interface simple.xml.stream.InputNode
-
Provides an attribute from the element represented.
- getAttributes() - Method in interface simple.xml.stream.InputNode
-
This returns a map of the attributes contained within the
element.
- getAttributes() - Method in interface simple.xml.stream.OutputNode
-
This returns a NodeMap
which can be used to add
nodes to the element before that element has been committed.
- getChild(String) - Method in interface simple.xml.stream.OutputNode
-
This is used to create a child element within the element that
this object represents.
- getElement(Class, NodeMap, Map) - Method in class simple.xml.graph.CycleStrategy
-
This method is used to read an object from the specified node.
- getElement(Class, NodeMap, Map) - Method in interface simple.xml.load.Strategy
-
This is used to resolve and load a class for the given element.
- getIndent() - Method in class simple.xml.stream.Format
-
This method returns the size of the indent to use for the XML
generated.
- getInstance() - Method in interface simple.xml.load.Type
-
This method is used to acquire an instance of the type that
is defined by this object.
- getInstance(Class) - Method in interface simple.xml.load.Type
-
This method is used to acquire an instance of the type that
is defined by this object.
- getLine() - Method in interface simple.xml.stream.Position
-
This is the actual line number within the read XML document.
- getMode() - Method in interface simple.xml.stream.OutputNode
-
The Mode
is used to indicate the output mode
of this node.
- getName() - Method in interface simple.xml.stream.Node
-
Returns the name of the node that this represents.
- getName() - Method in interface simple.xml.stream.NodeMap
-
This is used to get the name of the element that owns the
nodes for the specified map.
- getNext() - Method in interface simple.xml.stream.InputNode
-
This returns the next child element within this element if
one exists.
- getNext(String) - Method in interface simple.xml.stream.InputNode
-
This returns the next child in this element if that child
has the name provided.
- getParent() - Method in interface simple.xml.stream.InputNode
-
This is used to acquire the Node
that is the
parent of this node.
- getParent() - Method in interface simple.xml.stream.Node
-
This is used to acquire the Node
that is the
parent of this node.
- getParent() - Method in interface simple.xml.stream.OutputNode
-
This is used to acquire the Node
that is the
parent of this node.
- getPosition() - Method in interface simple.xml.stream.InputNode
-
This provides the position of this node within the document.
- getProlog() - Method in class simple.xml.stream.Format
-
This method returns the prolog that is to be used at the start
of the generated XML document.
- getRoot(Class, NodeMap, Map) - Method in class simple.xml.graph.CycleStrategy
-
This method is used to read an object from the specified node.
- getRoot(Class, NodeMap, Map) - Method in interface simple.xml.load.Strategy
-
This is used to resolve and load the root class type.
- getType() - Method in interface simple.xml.load.Type
-
This is the type of the object instance that will be created
by the getInstance
method.
- getValue() - Method in interface simple.xml.stream.Node
-
Returns the value for the node that this represents.
- pattern - Variable in class simple.xml.util.Match
-
This is the pattern string that is used by the resolver.
- Persist - Annotation Type in simple.xml.load
-
The Persist
annotation is used to mark a method that
requires a callback from the persister before serialization of
an object begins.
- PersistenceException - Exception in simple.xml.load
-
The PersistenceException
is thrown when there is a
persistance exception.
- PersistenceException(String, Object...) - Constructor for exception simple.xml.load.PersistenceException
-
Constructor for the PersistenceException
object.
- PersistenceException(Throwable, String, Object...) - Constructor for exception simple.xml.load.PersistenceException
-
Constructor for the PersistenceException
object.
- Persister - Class in simple.xml.load
-
The Persister
object is used to provide an implementation
of a serializer.
- Persister() - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Map) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Filter) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Format) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Filter, Format) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Format) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Map) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Map, Format) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter, Format) - Constructor for class simple.xml.load.Persister
-
Constructor for the Persister
object.
- PlatformFilter - Class in simple.xml.filter
-
The PlatformFilter
object makes use of all filter
types this resolves user specified properties first, followed
by system properties, and finally environment variables.
- PlatformFilter(Map) - Constructor for class simple.xml.filter.PlatformFilter
-
Constructor for the PlatformFilter
object.
- Position - Interface in simple.xml.stream
-
The Position
object is used to acquire the position
of the read cursor within the XML file.
- push(Filter) - Method in class simple.xml.filter.StackFilter
-
This pushes the the provided Filter
on to the top
of the stack.
- put(String, String) - Method in interface simple.xml.stream.NodeMap
-
This is used to add a new Node
to the map.
- read(Class<? extends T>, String) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, File) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, InputStream) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, InputStream, String) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, Reader) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, InputNode) - Method in class simple.xml.load.Persister
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, String) - Method in interface simple.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, File) - Method in interface simple.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, InputStream) - Method in interface simple.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, InputStream, String) - Method in interface simple.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Class<? extends T>, Reader) - Method in interface simple.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and convert it into an object
of the specified type.
- read(Reader) - Static method in class simple.xml.stream.NodeBuilder
-
This is used to create an InputNode
that can be
used to read XML from the specified reader.
- remove(String) - Method in interface simple.xml.stream.NodeMap
-
This is used to remove the Node
mapped to the
given name.
- remove() - Method in interface simple.xml.stream.OutputNode
-
This is used to remove any uncommitted changes.
- remove(String) - Method in class simple.xml.util.Dictionary
-
This is used to remove an Entry
from the set by
its name.
- remove(M) - Method in class simple.xml.util.Resolver
-
This is used to remove the Match
implementation
from the resolver.
- replace(String) - Method in class simple.xml.filter.EnvironmentFilter
-
Replaces the text provided with the value resolved from the
environment variables.
- replace(String) - Method in interface simple.xml.filter.Filter
-
Replaces the text provided with some property.
- replace(String) - Method in class simple.xml.filter.MapFilter
-
Replaces the text provided with the value resolved from the
specified Map
.
- replace(String) - Method in class simple.xml.filter.StackFilter
-
Replaces the text provided with the value resolved from the
stacked filters.
- replace(String) - Method in class simple.xml.filter.SystemFilter
-
Replaces the text provided with the value resolved from the
system properties.
- resolve(String) - Method in class simple.xml.util.Resolver
-
This will search the patterns in this Resolver
to
see if there is a pattern in it that matches the string given.
- Resolver<M extends Match> - Class in simple.xml.util
-
This is used to store Match
objects, which can then be
retrieved using a string by comparing that string to the pattern of
the Match
objects.
- Resolver() - Constructor for class simple.xml.util.Resolver
-
The default constructor will create a Resolver
without a large cache size.
- Root - Annotation Type in simple.xml
-
This Root
annotation is used to annotate classes that
need to be serialized.
- RootException - Exception in simple.xml.load
-
The RootException
is thrown if the Root
annotation is missing from a root object that is to be serialized
or deserialized.
- RootException(String, Object...) - Constructor for exception simple.xml.load.RootException
-
Constructor for the RootException
exception.
- RootException(Throwable, String, Object...) - Constructor for exception simple.xml.load.RootException
-
Constructor for the RootException
exception.
- Serializer - Interface in simple.xml
-
The Serializer
interface is used to represent objects
that can serialize and deserialize objects to an from XML.
- setAttribute(String, String) - Method in interface simple.xml.stream.OutputNode
-
This method is used for convinience to add an attribute node
to the attribute NodeMap
.
- setData(boolean) - Method in interface simple.xml.stream.OutputNode
-
This is used to set the output mode of this node to either
be CDATA or escaped.
- setElement(Class, Object, NodeMap, Map) - Method in class simple.xml.graph.CycleStrategy
-
This is used to set the reference in to the XML element that
is to be written.
- setElement(Class, Object, NodeMap, Map) - Method in interface simple.xml.load.Strategy
-
This is used to attach attribute values to the given node
map during the serialization process.
- setMode(Mode) - Method in interface simple.xml.stream.OutputNode
-
This is used to set the output mode of this node to either
be CDATA, escaped, or inherited.
- setRoot(Class, Object, NodeMap, Map) - Method in class simple.xml.graph.CycleStrategy
-
This is used to set the reference in to the XML element that
is to be written.
- setRoot(Class, Object, NodeMap, Map) - Method in interface simple.xml.load.Strategy
-
This is used to attach attributes values to the given node
map during the serialization process.
- setValue(String) - Method in interface simple.xml.stream.OutputNode
-
This is used to set a text value to the element.
- simple.xml - package simple.xml
-
- simple.xml.filter - package simple.xml.filter
-
- simple.xml.graph - package simple.xml.graph
-
- simple.xml.load - package simple.xml.load
-
- simple.xml.stream - package simple.xml.stream
-
- simple.xml.util - package simple.xml.util
-
- size() - Method in class simple.xml.util.Dictionary
-
This returns the number of Entry
objects within
the dictionary.
- size() - Method in class simple.xml.util.Resolver
-
Returns the number of matches that have been inserted into
the Resolver
.
- skip() - Method in interface simple.xml.stream.InputNode
-
This method is used to skip all child elements from this
element.
- StackFilter - Class in simple.xml.filter
-
The StackFilter
object provides a filter that can
be given a collection of filters which can be used to resolve a
replacement.
- StackFilter() - Constructor for class simple.xml.filter.StackFilter
-
Constructor for the StackFilter
object.
- Strategy - Interface in simple.xml.load
-
The Strategy
interface represents a strategy that can be
used to resolve and load the Class
objects that compose
a serializable object.
- SystemFilter - Class in simple.xml.filter
-
The SystemFilter
object is used to provide a filter
that will replace the specified values with system properties.
- SystemFilter() - Constructor for class simple.xml.filter.SystemFilter
-
Constructor for the SystemFilter
object.
- SystemFilter(Filter) - Constructor for class simple.xml.filter.SystemFilter
-
Constructor for the SystemFilter
object.
- write(Object, OutputNode) - Method in class simple.xml.load.Persister
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, File) - Method in class simple.xml.load.Persister
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, OutputStream) - Method in class simple.xml.load.Persister
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, OutputStream, String) - Method in class simple.xml.load.Persister
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, Writer) - Method in class simple.xml.load.Persister
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, File) - Method in interface simple.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, OutputStream) - Method in interface simple.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, OutputStream, String) - Method in interface simple.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, Writer) - Method in interface simple.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Writer) - Static method in class simple.xml.stream.NodeBuilder
-
This is used to create an OutputNode
that can be
used to write a well formed XML document.
- write(Writer, Format) - Static method in class simple.xml.stream.NodeBuilder
-
This is used to create an OutputNode
that can be
used to write a well formed XML document.