Package org.simpleframework.xml.core
Class Variable
java.lang.Object
org.simpleframework.xml.core.Variable
- All Implemented Interfaces:
Label
The
Variable
object is used to represent a variable
for a method or field of a deserialized object. It has the value
for the field or method as well as the details from the annotation.
This is used by the Collector
to populate an object
once all the values for that object have been collected.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
TheAdapter
object is used to call the repeater with the original deserialized object. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis acquires the annotation associated with this label.This is used to acquire the contact object for this label.getConverter
(Context context) This method returns aConverter
which can be used to convert an XML node into an object value and vice versa.This is used to acquire theDecorator
for this.This returns the dependent type for the annotation.This is used to provide a configured empty value used when the annotated value is null.getEntry()
This is used to either provide the entry value provided within the annotation or compute a entry value.This method is used to return an XPath expression that is used to represent the position of this label.getKey()
This is the key used to represent this label.This is used to acquire theLabel
that the type provided is represented by.getName()
This is used to acquire the name of the element or attribute that is used by the class schema.String[]
getNames()
This returns aCollection
of element names.This is used to acquire the name of the element or attribute as taken from the annotation.getPath()
This is used to acquire the path of the element or attribute that is used by the class schema.String[]
getPaths()
This returns aCollection
of element paths.getType()
This acts as a convenience method used to determine the type of the field this represents.This is used to acquire theType
that the type provided is represented by.getValue()
This is used to acquire the value associated with the variable.boolean
This method is used to determine if the label represents an attribute.boolean
This is used to determine if the label is a collection.boolean
isData()
This is used to determine whether the annotation requires it and its children to be written as a CDATA block.boolean
isInline()
This is used to determine whether the label represents an inline XML entity.boolean
Determines whether the XML attribute or element is required.boolean
isText()
This is used to determine if the label represents text.boolean
This is used to determine if an annotated list is a text list.boolean
isUnion()
This is used to determine if this label is a union.toString()
This is used to describe the annotation and method or field that this label represents.
-
Field Details
-
value
This is the object that has been deserialized from the XML. -
label
This contains the details for the annotated field or method.
-
-
Constructor Details
-
Variable
Constructor for theVariable
object. This is used to create an object that holds a deserialized value, as well as the details of the annotated method or field it is to be set to. This allows the value to be repeatedly deserialized.- Parameters:
label
- this is the label for the field or method usedvalue
- the deserialized object for the method or field
-
-
Method Details
-
getLabel
This is used to acquire theLabel
that the type provided is represented by. Typically this will return the same instance. However, in the case of unions this will look for an individual label to match the type provided. -
getType
This is used to acquire theType
that the type provided is represented by. Typically this will return the field or method represented by the label. However, in the case of unions this will provide an override type. -
getNames
This returns aCollection
of element names. This will typically contain both the name and path of the label. However, if this is a union it can contain many names and paths. This method should never return null. -
getPaths
This returns aCollection
of element paths. This will typically contain only the path of the label, which is composed using thePath
annotation and the name of the label. However, if this is a union it can contain many paths. This method should never return null. -
getValue
This is used to acquire the value associated with the variable. Once fully deserialized the value is used to set the value for a field or method of the object. This value can be repeatedly read if theConverter
is acquired a second time.- Returns:
- this returns the value that has been deserialized
-
getDecorator
This is used to acquire theDecorator
for this. A decorator is an object that adds various details to the node without changing the overall structure of the node. For example comments and namespaces can be added to the node with a decorator as they do not affect the deserialization.- Specified by:
getDecorator
in interfaceLabel
- Returns:
- this returns the decorator associated with this
- Throws:
Exception
-
getConverter
This method returns aConverter
which can be used to convert an XML node into an object value and vice versa. The converter requires only the context object in order to perform serialization or deserialization of the provided XML node.- Specified by:
getConverter
in interfaceLabel
- Parameters:
context
- this is the context object for the serialization- Returns:
- this returns an object that is used for conversion
- Throws:
Exception
-
getEmpty
This is used to provide a configured empty value used when the annotated value is null. This ensures that XML can be created with required details regardless of whether values are null or not. It also provides a means for sensible default values. -
getContact
This is used to acquire the contact object for this label. The contact retrieved can be used to set any object or primitive that has been deserialized, and can also be used to acquire values to be serialized in the case of object persistence. All contacts that are retrieved from this method will be accessible.- Specified by:
getContact
in interfaceLabel
- Returns:
- returns the field that this label is representing
-
getDependent
This returns the dependent type for the annotation. This type is the type other than the annotated field or method type that the label depends on. For theElementList
and theElementArray
this is the component type that is deserialized individually and inserted into the container.- Specified by:
getDependent
in interfaceLabel
- Returns:
- this is the type that the annotation depends on
- Throws:
Exception
-
getKey
This is the key used to represent this label. The key is used to store the parameter in hash containers. Typically the key is generated from the paths associated with the label. -
getEntry
This is used to either provide the entry value provided within the annotation or compute a entry value. If the entry string is not provided the the entry value is calculated as the type of primitive the object is as a simplified class name. -
getName
This is used to acquire the name of the element or attribute that is used by the class schema. The name is determined by checking for an override within the annotation. If it contains a name then that is used, if however the annotation does not specify a name the the field or method name is used instead. -
getAnnotation
This acquires the annotation associated with this label. This is typically the annotation acquired from the field or method. However, in the case of unions this will return the actual annotation within the union group that this represents.- Specified by:
getAnnotation
in interfaceLabel
- Returns:
- this returns the annotation that this represents
-
getPath
This is used to acquire the path of the element or attribute that is used by the class schema. The path is determined by acquiring the XPath expression and appending the name of the label to form a fully qualified path. -
getExpression
This method is used to return an XPath expression that is used to represent the position of this label. If there is no XPath expression associated with this then an empty path is returned. This will never return a null expression.- Specified by:
getExpression
in interfaceLabel
- Returns:
- the XPath expression identifying the location
- Throws:
Exception
-
getOverride
This is used to acquire the name of the element or attribute as taken from the annotation. If the element or attribute explicitly specifies a name then that name is used for the XML element or attribute used. If however no overriding name is provided then the method or field is used for the name.- Specified by:
getOverride
in interfaceLabel
- Returns:
- returns the name of the annotation for the contact
-
getType
This acts as a convenience method used to determine the type of the field this represents. This is used when an object is written to XML. It determines whether aclass
attribute is required within the serialized XML element, that is, if the class returned by this is different from the actual value of the object to be serialized then that type needs to be remembered. -
isData
public boolean isData()This is used to determine whether the annotation requires it and its children to be written as a CDATA block. This is done when a primitive or other such element requires a text value and that value needs to be encapsulated within a CDATA block. -
isInline
public boolean isInline()This is used to determine whether the label represents an inline XML entity. TheElementList
annotation and theText
annotation represent inline items. This means that they contain no containing element and so can not specify overrides or special attributes. -
isAttribute
public boolean isAttribute()This method is used to determine if the label represents an attribute. This is used to style the name so that elements are styled as elements and attributes are styled as required.- Specified by:
isAttribute
in interfaceLabel
- Returns:
- this is used to determine if this is an attribute
-
isCollection
public boolean isCollection()This is used to determine if the label is a collection. If the label represents a collection then any original assignment to the field or method can be written to without the need to create a new collection. This allows obscure collections to be used and also allows initial entries to be maintained.- Specified by:
isCollection
in interfaceLabel
- Returns:
- true if the label represents a collection value
-
isRequired
public boolean isRequired()Determines whether the XML attribute or element is required. This ensures that if an XML element is missing from a document that deserialization can continue. Also, in the process of serialization, if a value is null it does not need to be written to the resulting XML document.- Specified by:
isRequired
in interfaceLabel
- Returns:
- true if the label represents a some required data
-
isText
public boolean isText()This is used to determine if the label represents text. If a label represents text it typically does not have a name, instead the empty string represents the name. Also text labels can not exist with other text labels, or elements. -
isTextList
public boolean isTextList()This is used to determine if an annotated list is a text list. A text list is a list of elements that also accepts free text. Typically this will be an element list union that will allow unstructured XML such as XHTML to be parsed.- Specified by:
isTextList
in interfaceLabel
- Returns:
- returns true if the label represents a text list
-
isUnion
public boolean isUnion()This is used to determine if this label is a union. If this is true then this label represents a number of labels and is simply a wrapper for these labels. -
toString
This is used to describe the annotation and method or field that this label represents. This is used to provide error messages that can be used to debug issues that occur when processing a method. This should provide enough information such that the problem can be isolated correctly.
-