- Cache<T> - Interface in org.simpleframework.xml.util
-
The Cache
interface is used to represent a cache
that will store key value pairs.
- cache(Object, T) - Method in interface org.simpleframework.xml.util.Cache
-
This method is used to insert a key value mapping in to the
cache.
- cache(Object, T) - Method in class org.simpleframework.xml.util.ConcurrentCache
-
This method is used to insert a key value mapping in to the
cache.
- cache(Object, T) - Method in class org.simpleframework.xml.util.LimitedCache
-
This method is used to insert a key value mapping in to the
cache.
- cache - Variable in class org.simpleframework.xml.util.Resolver
-
Caches the text resolutions made to reduce the work required.
- cache(Object, T) - Method in class org.simpleframework.xml.util.WeakCache
-
This method is used to insert a key value mapping in to the
cache.
- CamelCaseStyle - Class in org.simpleframework.xml.stream
-
The CamelCaseStyle
is used to represent an XML style
that can be applied to a serialized object.
- CamelCaseStyle() - Constructor for class org.simpleframework.xml.stream.CamelCaseStyle
-
Constructor for the CamelCaseStyle
object.
- CamelCaseStyle(boolean) - Constructor for class org.simpleframework.xml.stream.CamelCaseStyle
-
Constructor for the CamelCaseStyle
object.
- CamelCaseStyle(boolean, boolean) - Constructor for class org.simpleframework.xml.stream.CamelCaseStyle
-
Constructor for the CamelCaseStyle
object.
- clear() - Method in class org.simpleframework.xml.util.Resolver
-
This is used to clear all matches from the set.
- Commit - Annotation Type in org.simpleframework.xml.core
-
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 org.simpleframework.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 org.simpleframework.xml.core
-
The Complete
annotation is used to mark a method that
requires a callback from the persister once the serialization of
the object has completed.
- ConcurrentCache<T> - Class in org.simpleframework.xml.util
-
The ConcurrentCache
interface is used to represent a
cache that will store key value pairs.
- ConcurrentCache() - Constructor for class org.simpleframework.xml.util.ConcurrentCache
-
Constructor for the ConcurrentCache
object.
- ConstructorException - Exception in org.simpleframework.xml.core
-
The ConstructorException
is used to represent any
errors where an annotated constructor parameter is invalid.
- ConstructorException(String, Object...) - Constructor for exception org.simpleframework.xml.core.ConstructorException
-
Constructor for the ConstructorException
object.
- ConstructorException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.core.ConstructorException
-
Constructor for the ConstructorException
object.
- contains(Object) - Method in interface org.simpleframework.xml.util.Cache
-
This is used to determine whether the specified key exists
with in the cache.
- contains(Object) - Method in class org.simpleframework.xml.util.ConcurrentCache
-
This is used to determine whether the specified key exists
with in the cache.
- contains(Object) - Method in class org.simpleframework.xml.util.LimitedCache
-
This is used to determine whether the specified key exists
with in the cache.
- contains(Object) - Method in class org.simpleframework.xml.util.WeakCache
-
This is used to determine whether the specified key exists
with in the cache.
- Convert - Annotation Type in org.simpleframework.xml.convert
-
The Convert
annotation is used to specify a converter
class to use for serialization.
- Converter<T> - Interface in org.simpleframework.xml.convert
-
The Converter
object is used to convert an object
to XML by intercepting the normal serialization process.
- ConvertException - Exception in org.simpleframework.xml.convert
-
The ConvertException
is thrown when there is a
problem converting an object.
- ConvertException(String, Object...) - Constructor for exception org.simpleframework.xml.convert.ConvertException
-
Constructor for the ConvertException
object.
- CycleException - Exception in org.simpleframework.xml.strategy
-
The CycleException
is thrown when an invalid cycle
is found when deserializing an object from an XML document.
- CycleException(String, Object...) - Constructor for exception org.simpleframework.xml.strategy.CycleException
-
Constructor for the CycleException
object.
- CycleException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.strategy.CycleException
-
Constructor for the CycleException
object.
- CycleStrategy - Class in org.simpleframework.xml.strategy
-
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 org.simpleframework.xml.strategy.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String) - Constructor for class org.simpleframework.xml.strategy.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String, String) - Constructor for class org.simpleframework.xml.strategy.CycleStrategy
-
Constructor for the CycleStrategy
object.
- CycleStrategy(String, String, String, String) - Constructor for class org.simpleframework.xml.strategy.CycleStrategy
-
Constructor for the CycleStrategy
object.
- get(String) - Method in interface org.simpleframework.xml.stream.NodeMap
-
This is used to acquire the Node
mapped to the
given name.
- get(String) - Method in class org.simpleframework.xml.util.Dictionary
-
This is used to acquire an Entry
from the set by
its name.
- getAnnotation(Class<T>) - Method in interface org.simpleframework.xml.strategy.Type
-
This is the annotation associated with the method or field
that has been annotated.
- getAttribute(String) - Method in class org.simpleframework.xml.stream.CamelCaseStyle
-
This is used to generate the XML attribute representation of
the specified name.
- getAttribute(String) - Method in class org.simpleframework.xml.stream.HyphenStyle
-
This is used to generate the XML attribute representation of
the specified name.
- getAttribute(String) - Method in interface org.simpleframework.xml.stream.InputNode
-
Provides an attribute from the element represented.
- getAttribute(String) - Method in interface org.simpleframework.xml.stream.Style
-
This is used to generate the XML attribute representation of
the specified name.
- getAttributes() - Method in interface org.simpleframework.xml.stream.InputNode
-
This returns a map of the attributes contained within the
element.
- getAttributes() - Method in interface org.simpleframework.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 org.simpleframework.xml.stream.OutputNode
-
This is used to create a child element within the element that
this object represents.
- getComment() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to get the text comment for the element.
- getElement(String) - Method in class org.simpleframework.xml.stream.CamelCaseStyle
-
This is used to generate the XML element representation of
the specified name.
- getElement(String) - Method in class org.simpleframework.xml.stream.HyphenStyle
-
This is used to generate the XML element representation of
the specified name.
- getElement(String) - Method in interface org.simpleframework.xml.stream.Style
-
This is used to generate the XML element representation of
the specified name.
- getIndent() - Method in class org.simpleframework.xml.stream.Format
-
This method returns the size of the indent to use for the XML
generated.
- getLength() - Method in interface org.simpleframework.xml.strategy.Value
-
This returns the length of the array that is to be allocated.
- getLine() - Method in interface org.simpleframework.xml.stream.Position
-
This is the actual line number within the read XML document.
- getMode() - Method in interface org.simpleframework.xml.stream.OutputNode
-
The Mode
is used to indicate the output mode
of this node.
- getName() - Method in interface org.simpleframework.xml.stream.Node
-
Returns the name of the node that this represents.
- getName() - Method in interface org.simpleframework.xml.stream.NodeMap
-
This is used to get the name of the element that owns the
nodes for the specified map.
- getName() - Method in interface org.simpleframework.xml.util.Entry
-
Represents the name of the entry instance used for mappings.
- getNamespaces() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This returns the NamespaceMap
for this node.
- getNext() - Method in interface org.simpleframework.xml.stream.InputNode
-
This returns the next child element within this element if
one exists.
- getNext(String) - Method in interface org.simpleframework.xml.stream.InputNode
-
This returns the next child in this element if that child
has the name provided.
- getNode() - Method in interface org.simpleframework.xml.stream.NodeMap
-
This is used to acquire the actual node this map represents.
- getParent() - Method in interface org.simpleframework.xml.stream.InputNode
-
This is used to acquire the Node
that is the
parent of this node.
- getParent() - Method in interface org.simpleframework.xml.stream.Node
-
This is used to acquire the Node
that is the
parent of this node.
- getParent() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to acquire the Node
that is the
parent of this node.
- getPattern() - Method in interface org.simpleframework.xml.util.Match
-
This is the pattern string that is used by the resolver.
- getPosition() - Method in interface org.simpleframework.xml.stream.InputNode
-
This provides the position of this node within the document.
- getPrefix() - Method in interface org.simpleframework.xml.stream.InputNode
-
This is used to acquire the namespace prefix for the node.
- getPrefix() - Method in interface org.simpleframework.xml.stream.NamespaceMap
-
This is the prefix that is associated with the source element.
- getPrefix(String) - Method in interface org.simpleframework.xml.stream.NamespaceMap
-
This acquires the prefix for the specified namespace reference.
- getPrefix() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to acquire the prefix for this output node.
- getPrefix(boolean) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to acquire the prefix for this output node.
- getProlog() - Method in class org.simpleframework.xml.stream.Format
-
This method returns the prolog that is to be used at the start
of the generated XML document.
- getReference() - Method in interface org.simpleframework.xml.stream.InputNode
-
This allows the namespace reference URI to be determined.
- getReference(String) - Method in interface org.simpleframework.xml.stream.NamespaceMap
-
This acquires the namespace reference for the specified prefix.
- getReference() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to acquire the namespace URI reference associated
with this node.
- getSource() - Method in interface org.simpleframework.xml.stream.InputNode
-
This is used to return the source object for this node.
- getStyle() - Method in class org.simpleframework.xml.stream.Format
-
This is used to acquire the Style
for the format.
- getType() - Method in interface org.simpleframework.xml.strategy.Type
-
This will provide the method or field type.
- getType() - Method in interface org.simpleframework.xml.strategy.Value
-
This is the type of the object instance this represents.
- getValue() - Method in interface org.simpleframework.xml.strategy.Value
-
This method is used to acquire an instance of the type that
is defined by this object.
- getValue() - Method in interface org.simpleframework.xml.stream.Node
-
Returns the value for the node that this represents.
- getVerbosity() - Method in class org.simpleframework.xml.stream.Format
-
This method is used to indicate the preference of verbosity
for the resulting XML.
- Path - Annotation Type in org.simpleframework.xml
-
The Path
annotation is used to specify an XML path
where an XML element or attribute is located.
- PathException - Exception in org.simpleframework.xml.core
-
The PathException
is thrown when there is a problem
with the syntax of an XPath expression.
- PathException(String, Object...) - Constructor for exception org.simpleframework.xml.core.PathException
-
Constructor for the PathException
object.
- Persist - Annotation Type in org.simpleframework.xml.core
-
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 org.simpleframework.xml.core
-
The PersistenceException
is thrown when there is a
persistance exception.
- PersistenceException(String, Object...) - Constructor for exception org.simpleframework.xml.core.PersistenceException
-
Constructor for the PersistenceException
object.
- PersistenceException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.core.PersistenceException
-
Constructor for the PersistenceException
object.
- Persister - Class in org.simpleframework.xml.core
-
The Persister
object is used to provide an implementation
of a serializer.
- Persister() - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Map) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Map, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Filter) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Filter, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Matcher) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Matcher, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Filter, Matcher) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Filter, Matcher, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Map) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Map, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Matcher) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Matcher, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter, Matcher) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- Persister(Strategy, Filter, Matcher, Format) - Constructor for class org.simpleframework.xml.core.Persister
-
Constructor for the Persister
object.
- PlatformFilter - Class in org.simpleframework.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() - Constructor for class org.simpleframework.xml.filter.PlatformFilter
-
Constructor for the PlatformFilter
object.
- PlatformFilter(Map) - Constructor for class org.simpleframework.xml.filter.PlatformFilter
-
Constructor for the PlatformFilter
object.
- Position - Interface in org.simpleframework.xml.stream
-
The Position
object is used to acquire the position
of the read cursor within the XML file.
- push(Filter) - Method in class org.simpleframework.xml.filter.StackFilter
-
This pushes the the provided Filter
on to the top
of the stack.
- put(String, String) - Method in interface org.simpleframework.xml.stream.NodeMap
-
This is used to add a new Node
to the map.
- read(Type, NodeMap<InputNode>, Map) - Method in class org.simpleframework.xml.convert.AnnotationStrategy
-
This is used to read the Value
which will be used
to represent the deserialized object.
- read(InputNode) - Method in interface org.simpleframework.xml.convert.Converter
-
This read
method is used to deserialize an object
from the source XML.
- read(Type, NodeMap<InputNode>, Map) - Method in class org.simpleframework.xml.convert.RegistryStrategy
-
This is used to read the Value
which will be used
to represent the deserialized object.
- read(Class<? extends T>, String) - Method in class org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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, boolean) - Method in class org.simpleframework.xml.core.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, boolean) - Method in class org.simpleframework.xml.core.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, boolean) - Method in class org.simpleframework.xml.core.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, boolean) - Method in class org.simpleframework.xml.core.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, boolean) - Method in class org.simpleframework.xml.core.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(T, String) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, File) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputStream) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, Reader) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputNode) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, String, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, File, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputStream, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, Reader, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputNode, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(Class<? extends T>, String) - Method in interface org.simpleframework.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 org.simpleframework.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 org.simpleframework.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 org.simpleframework.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>, InputNode) - Method in interface org.simpleframework.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>, String, boolean) - Method in interface org.simpleframework.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, boolean) - Method in interface org.simpleframework.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, boolean) - Method in interface org.simpleframework.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, boolean) - Method in interface org.simpleframework.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>, InputNode, boolean) - Method in interface org.simpleframework.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(T, String) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, File) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputStream) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, Reader) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputNode) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, String, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, File, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputStream, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, Reader, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(T, InputNode, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This read
method will read the contents of the XML
document from the provided source and populate the object with
the values deserialized.
- read(Type, NodeMap, Map) - Method in class org.simpleframework.xml.strategy.CycleStrategy
-
This method is used to read an object from the specified node.
- read(Type, NodeMap<InputNode>, Map) - Method in interface org.simpleframework.xml.strategy.Strategy
-
This is used to resolve and load a class for the given element.
- read(Type, NodeMap, Map) - Method in class org.simpleframework.xml.strategy.TreeStrategy
-
This is used to resolve and load a class for the given element.
- read(Type, NodeMap<InputNode>) - Method in interface org.simpleframework.xml.strategy.Visitor
-
This is used to intercept an XML element before it is read
by the underlying Strategy
implementation.
- read(Type, NodeMap<InputNode>, Map) - Method in class org.simpleframework.xml.strategy.VisitorStrategy
-
This method will read with an internal strategy after it has
been intercepted by the visitor.
- read(InputStream) - Static method in class org.simpleframework.xml.stream.NodeBuilder
-
This is used to create an InputNode
that can be
used to read XML from the specified stream.
- read(Reader) - Static method in class org.simpleframework.xml.stream.NodeBuilder
-
This is used to create an InputNode
that can be
used to read XML from the specified reader.
- read(String) - Method in interface org.simpleframework.xml.transform.Transform
-
This method is used to convert the string value given to an
appropriate representation.
- read(String, Class) - Method in class org.simpleframework.xml.transform.Transformer
-
This method is used to convert the string value given to an
appropriate representation.
- Registry - Class in org.simpleframework.xml.convert
-
The Registry
represents an object that is used to
register bindings between a class and a converter implementation.
- Registry() - Constructor for class org.simpleframework.xml.convert.Registry
-
Constructor for the Registry
object.
- RegistryMatcher - Class in org.simpleframework.xml.transform
-
The RegistryMatcher
provides a simple matcher backed
by a registry.
- RegistryMatcher() - Constructor for class org.simpleframework.xml.transform.RegistryMatcher
-
Constructor for the RegistryMatcher
.
- RegistryStrategy - Class in org.simpleframework.xml.convert
-
The RegistryStrategy
object is used to intercept
the serialization process and delegate to custom converters.
- RegistryStrategy(Registry) - Constructor for class org.simpleframework.xml.convert.RegistryStrategy
-
Constructor for the RegistryStrategy
object.
- RegistryStrategy(Registry, Strategy) - Constructor for class org.simpleframework.xml.convert.RegistryStrategy
-
Constructor for the RegistryStrategy
object.
- remove(String) - Method in interface org.simpleframework.xml.stream.NodeMap
-
This is used to remove the Node
mapped to the
given name.
- remove() - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to remove any uncommitted changes.
- remove(String) - Method in class org.simpleframework.xml.util.Dictionary
-
This is used to remove an Entry
from the set by
its name.
- remove(M) - Method in class org.simpleframework.xml.util.Resolver
-
This is used to remove the Match
implementation
from the resolver.
- removeEldestEntry(Map.Entry<Object, T>) - Method in class org.simpleframework.xml.util.LimitedCache
-
This is used to remove the eldest entry from the cache.
- Replace - Annotation Type in org.simpleframework.xml.core
-
The Replace
method is used to replace an object that
is about to be serialized to an XML document.
- replace(String) - Method in class org.simpleframework.xml.filter.EnvironmentFilter
-
Replaces the text provided with the value resolved from the
environment variables.
- replace(String) - Method in interface org.simpleframework.xml.filter.Filter
-
Replaces the text provided with some property.
- replace(String) - Method in class org.simpleframework.xml.filter.MapFilter
-
Replaces the text provided with the value resolved from the
specified Map
.
- replace(String) - Method in class org.simpleframework.xml.filter.StackFilter
-
Replaces the text provided with the value resolved from the
stacked filters.
- replace(String) - Method in class org.simpleframework.xml.filter.SystemFilter
-
Replaces the text provided with the value resolved from the
system properties.
- Resolve - Annotation Type in org.simpleframework.xml.core
-
The Resolve
method is used to resolve an object that
has been deserialized from the XML document.
- resolve(String) - Method in class org.simpleframework.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.
- resolveAll(String) - Method in class org.simpleframework.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 org.simpleframework.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 org.simpleframework.xml.util.Resolver
-
The default constructor will create a Resolver
without a large cache size.
- Root - Annotation Type in org.simpleframework.xml
-
This Root
annotation is used to annotate classes that
need to be serialized.
- RootException - Exception in org.simpleframework.xml.core
-
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 org.simpleframework.xml.core.RootException
-
Constructor for the RootException
exception.
- RootException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.core.RootException
-
Constructor for the RootException
exception.
- Serializer - Interface in org.simpleframework.xml
-
The Serializer
interface is used to represent objects
that can serialize and deserialize objects to an from XML.
- setAttribute(String, String) - Method in class org.simpleframework.xml.stream.CamelCaseStyle
-
This is used to set the attribute values within this builder.
- setAttribute(String, String) - Method in class org.simpleframework.xml.stream.HyphenStyle
-
This is used to set the attribute values within this builder.
- setAttribute(String, String) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This method is used for convenience to add an attribute node
to the attribute NodeMap
.
- setComment(String) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to set a text comment to the element.
- setData(boolean) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to set the output mode of this node to either
be CDATA or escaped.
- setElement(String, String) - Method in class org.simpleframework.xml.stream.CamelCaseStyle
-
This is used to set the element values within this builder.
- setElement(String, String) - Method in class org.simpleframework.xml.stream.HyphenStyle
-
This is used to set the element values within this builder.
- setMode(Mode) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to set the output mode of this node to either
be CDATA, escaped, or inherited.
- setName(String) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to change the name of an output node.
- setReference(String) - Method in interface org.simpleframework.xml.stream.NamespaceMap
-
This is used to add the namespace reference to the namespace
map.
- setReference(String, String) - Method in interface org.simpleframework.xml.stream.NamespaceMap
-
This is used to add the namespace reference to the namespace
map.
- setReference(String) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to set the reference for the node.
- setValue(Object) - Method in interface org.simpleframework.xml.strategy.Value
-
This method is used set the value within this object.
- setValue(String) - Method in interface org.simpleframework.xml.stream.OutputNode
-
This is used to set a text value to the element.
- size() - Method in class org.simpleframework.xml.util.Dictionary
-
This returns the number of Entry
objects within
the dictionary.
- size() - Method in class org.simpleframework.xml.util.Resolver
-
Returns the number of matches that have been inserted into
the Resolver
.
- skip() - Method in interface org.simpleframework.xml.stream.InputNode
-
This method is used to skip all child elements from this
element.
- stack - Variable in class org.simpleframework.xml.util.Resolver
-
Stores the matches added to the resolver in resolution order.
- StackFilter - Class in org.simpleframework.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 org.simpleframework.xml.filter.StackFilter
-
Constructor for the StackFilter
object.
- Strategy - Interface in org.simpleframework.xml.strategy
-
The Strategy
interface represents a strategy that can be
used to resolve and load the Class
objects that compose
a serializable object.
- Style - Interface in org.simpleframework.xml.stream
-
The Style
interface is used to represent an XML style
that can be applied to a serialized object.
- SystemFilter - Class in org.simpleframework.xml.filter
-
The SystemFilter
object is used to provide a filter
that will replace the specified values with system properties.
- SystemFilter() - Constructor for class org.simpleframework.xml.filter.SystemFilter
-
Constructor for the SystemFilter
object.
- SystemFilter(Filter) - Constructor for class org.simpleframework.xml.filter.SystemFilter
-
Constructor for the SystemFilter
object.
- take(Object) - Method in interface org.simpleframework.xml.util.Cache
-
This is used to exclusively take the value mapped to the
specified key from the cache.
- take(Object) - Method in class org.simpleframework.xml.util.ConcurrentCache
-
This is used to exclusively take the value mapped to the
specified key from the cache.
- take(Object) - Method in class org.simpleframework.xml.util.LimitedCache
-
This is used to exclusively take the value mapped to the
specified key from the cache.
- take(Object) - Method in class org.simpleframework.xml.util.WeakCache
-
This is used to exclusively take the value mapped to the
specified key from the cache.
- Text - Annotation Type in org.simpleframework.xml
-
The Text
annotation is used to represent a field or
method that appears as text within an XML element.
- TextException - Exception in org.simpleframework.xml.core
-
The TextException
is used to represent conditions
when an XML element text value is in an invalid state.
- TextException(String, Object...) - Constructor for exception org.simpleframework.xml.core.TextException
-
Constructor for the TextException
object.
- TextException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.core.TextException
-
Constructor for the TextException
object.
- toString() - Method in interface org.simpleframework.xml.strategy.Type
-
This is used to describe the type as it exists within the
owning class.
- toString() - Method in interface org.simpleframework.xml.stream.Position
-
This provides a textual description of the position the
read cursor is at within the XML document.
- Transform<T> - Interface in org.simpleframework.xml.transform
-
A Transform
represents a an object used to transform
an object to and from a string value.
- Transformer - Class in org.simpleframework.xml.transform
-
The Transformer
object is used to convert strings to
and from object instances.
- Transformer(Matcher) - Constructor for class org.simpleframework.xml.transform.Transformer
-
Constructor for the Transformer
object.
- TransformException - Exception in org.simpleframework.xml.transform
-
The TransformException
is thrown if a problem occurs
during the transformation of an object.
- TransformException(String, Object...) - Constructor for exception org.simpleframework.xml.transform.TransformException
-
Constructor for the TransformException
object.
- TransformException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.transform.TransformException
-
Constructor for the TransformException
object.
- Transient - Annotation Type in org.simpleframework.xml
-
The Transient
annotation is an optional annotation
that can be used within an XML class schema to mark a method or
field as being transient, which indicates that it does not take
part in serialization or deserialization.
- TreeStrategy - Class in org.simpleframework.xml.strategy
-
The TreeStrategy
object is used to provide a simple
strategy for handling object graphs in a tree structure.
- TreeStrategy() - Constructor for class org.simpleframework.xml.strategy.TreeStrategy
-
Constructor for the TreeStrategy
object.
- TreeStrategy(String, String) - Constructor for class org.simpleframework.xml.strategy.TreeStrategy
-
Constructor for the TreeStrategy
object.
- Type - Interface in org.simpleframework.xml.strategy
-
The Type
interface is used to represent a method or
field that has been annotated for serialization.
- valid(Class) - Method in class org.simpleframework.xml.transform.Transformer
-
This method is used to determine if the type specified can be
transformed.
- validate(Class, String) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, File) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputStream) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, Reader) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputNode) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, String, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, File, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputStream, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, Reader, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputNode, boolean) - Method in class org.simpleframework.xml.core.Persister
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- Validate - Annotation Type in org.simpleframework.xml.core
-
The Validate
annotation is used to mark a method in
a serializable object that requires a callback from the persister
once the deserialization completes.
- validate(Class, String) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, File) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputStream) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, Reader) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputNode) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, String, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, File, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputStream, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, Reader, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- validate(Class, InputNode, boolean) - Method in interface org.simpleframework.xml.Serializer
-
This validate
method will validate the contents of
the XML document against the specified XML class schema.
- Value - Interface in org.simpleframework.xml.strategy
-
The Value
object describes a type that is represented
by an XML element.
- valueOf(String) - Static method in enum org.simpleframework.xml.DefaultType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.xml.stream.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.xml.stream.Verbosity
-
Returns the enum constant of this type with the specified name.
- ValueRequiredException - Exception in org.simpleframework.xml.core
-
The ValueRequiredException
is thrown when an attribute
or element is missing from the XML document.
- ValueRequiredException(String, Object...) - Constructor for exception org.simpleframework.xml.core.ValueRequiredException
-
Constructor for the ValueRequiredException
object.
- ValueRequiredException(Throwable, String, Object...) - Constructor for exception org.simpleframework.xml.core.ValueRequiredException
-
Constructor for the ValueRequiredException
object.
- values() - Static method in enum org.simpleframework.xml.DefaultType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.simpleframework.xml.stream.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.simpleframework.xml.stream.Verbosity
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- Verbosity - Enum in org.simpleframework.xml.stream
-
The Verbosity
enumeration is used to specify a verbosity
preference for the resulting XML.
- Version - Annotation Type in org.simpleframework.xml
-
The Version
annotation is used to specify an attribute
that is used to represent a revision of the class XML schema.
- Visitor - Interface in org.simpleframework.xml.strategy
-
The Visitor
interface represents an object that is
used to visit each XML element during serialization.
- VisitorStrategy - Class in org.simpleframework.xml.strategy
-
The VisitorStrategy
object is a simplification of a
strategy, which allows manipulation of the serialization process.
- VisitorStrategy(Visitor) - Constructor for class org.simpleframework.xml.strategy.VisitorStrategy
-
Constructor for the VisitorStrategy
object.
- VisitorStrategy(Visitor, Strategy) - Constructor for class org.simpleframework.xml.strategy.VisitorStrategy
-
Constructor for the VisitorStrategy
object.
- WeakCache<T> - Class in org.simpleframework.xml.util
-
The WeakCache
object is an implementation of a cache
that holds on to cached items only if the key remains in memory.
- WeakCache() - Constructor for class org.simpleframework.xml.util.WeakCache
-
Constructor for the WeakCache
object.
- WeakCache(int) - Constructor for class org.simpleframework.xml.util.WeakCache
-
Constructor for the WeakCache
object.
- write(Type, Object, NodeMap<OutputNode>, Map) - Method in class org.simpleframework.xml.convert.AnnotationStrategy
-
This is used to serialize a representation of the object value
provided.
- write(OutputNode, T) - Method in interface org.simpleframework.xml.convert.Converter
-
This write
method is used to serialize an object
to XML.
- write(Type, Object, NodeMap<OutputNode>, Map) - Method in class org.simpleframework.xml.convert.RegistryStrategy
-
This is used to serialize a representation of the object value
provided.
- write(Object, OutputNode) - Method in class org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.xml.core.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 org.simpleframework.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 org.simpleframework.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 org.simpleframework.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Object, OutputNode) - Method in interface org.simpleframework.xml.Serializer
-
This write
method will traverse the provided object
checking for field annotations in order to compose the XML data.
- write(Type, Object, NodeMap, Map) - Method in class org.simpleframework.xml.strategy.CycleStrategy
-
This is used to write the reference in to the XML element that
is to be written.
- write(Type, Object, NodeMap<OutputNode>, Map) - Method in interface org.simpleframework.xml.strategy.Strategy
-
This is used to attach attribute values to the given node
map during the serialization process.
- write(Type, Object, NodeMap, Map) - Method in class org.simpleframework.xml.strategy.TreeStrategy
-
This is used to attach a attribute to the provided element
that is used to identify the class.
- write(Type, NodeMap<OutputNode>) - Method in interface org.simpleframework.xml.strategy.Visitor
-
This is used to intercept an XML element after it is written
by the underlying Strategy
implementation.
- write(Type, Object, NodeMap<OutputNode>, Map) - Method in class org.simpleframework.xml.strategy.VisitorStrategy
-
This method will write with an internal strategy before it has
been intercepted by the visitor.
- write(Writer) - Static method in class org.simpleframework.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 org.simpleframework.xml.stream.NodeBuilder
-
This is used to create an OutputNode
that can be
used to write a well formed XML document.
- write(T) - Method in interface org.simpleframework.xml.transform.Transform
-
This method is used to convert the provided value into an XML
usable format.
- write(Object, Class) - Method in class org.simpleframework.xml.transform.Transformer
-
This method is used to convert the provided value into an XML
usable format.