Package org.simpleframework.xml.core
Interface Criteria
- All Known Implementing Classes:
Collector
The
Criteria
object represents the criteria used to
create an object and populate its methods and fields. This allows
all deserialized information for a single object to be stored in
a single location. All deserialized variables are accessible from
the get
method.-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is used to set the values for the methods and fields of the specified object.This is used to get theVariable
that represents a deserialized object.This is used to get theVariable
that represents a deserialized object.This is used to remove theVariable
from this criteria object.This is used to resolve theVariable
by using the union names of a label.void
This is used to create aVariable
and set it for this criteria.Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Method Details
-
get
This is used to get theVariable
that represents a deserialized object. The variable contains all the meta data for the field or method and the value that is to be set on the method or field.- Parameters:
key
- this is the key of the variable to be acquired- Returns:
- this returns the keyed variable if it exists
- Throws:
Exception
-
get
This is used to get theVariable
that represents a deserialized object. The variable contains all the meta data for the field or method and the value that is to be set on the method or field.- Parameters:
label
- this is the label to acquire the variable for- Returns:
- this returns the variable associated with the label
- Throws:
Exception
-
resolve
This is used to resolve theVariable
by using the union names of a label. This will also acquire variables based on the actual name of the variable.- Parameters:
path
- this is the path of the variable to be acquired- Returns:
- this returns the variable mapped to the path
- Throws:
Exception
-
remove
This is used to remove theVariable
from this criteria object. When removed, the variable will no longer be used to set the method or field when thecommit
method is invoked.- Parameters:
key
- this is the key associated with the variable- Returns:
- this returns the keyed variable if it exists
- Throws:
Exception
-
set
This is used to create aVariable
and set it for this criteria. The variable can be retrieved at a later stage using the name of the label. This allows for repeat reads as the variable can be used to acquire the labels converter.- Parameters:
label
- this is the label used to create the pointervalue
- this is the value of the object to be read- Throws:
Exception
-
commit
This is used to set the values for the methods and fields of the specified object. Invoking this performs the population of an object being deserialized. It ensures that each value is set after the XML element has been fully read.- Parameters:
source
- this is the object that is to be populated- Throws:
Exception
-