java.lang.Object
- org.simpleframework.xml.core.CacheLabel

All Implemented Interfaces:

Label
```
class CacheLabel
extends java.lang.Object
implements Label
```
The CacheLabel object is used to acquire details from an inner label object so that details can be retrieved repeatedly without the need to perform any logic for extracting the values. This ensures that a class XML schema requires only initial processing the first time the class XML schema is required.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.annotation.Annotation`	`annotation`	This is the annotation that this label instance represents.
`private boolean`	`attribute`	This is used to determine the styling of the label name.
`private boolean`	`collection`	This is used to determine if the label represents a collection.
`private Contact`	`contact`	This is the contact used to set and get the value for the node.
`private boolean`	`data`	This is used to represent whether the data is written as data.
`private Decorator`	`decorator`	This is the decorator that is associated with the label.
`private Type`	`depend`	This is used to represent the dependent type to be used.
`private java.lang.String`	`entry`	This is used to represent the name of the entry item use.
`private Expression`	`expression`	This is the expression that is used to represent this label.
`private boolean`	`inline`	This is used to determine whether the entity is inline or not.
`private java.lang.Object`	`key`	This is the key is used to represent this label object.
`private Label`	`label`	This is the label the this cache is wrapping the values for.
`private boolean`	`list`	This is used to determine if the label represents a text list.
`private java.lang.String`	`name`	This is used to represent the name of the annotated element.
`private java.lang.String[]`	`names`	This represents the names that identify this label instance.
`private java.lang.String`	`override`	This is used to represent the name override for the annotation.
`private java.lang.String`	`path`	This represents the path location within the XML for this.
`private java.lang.String[]`	`paths`	This represents the paths that identify this label instance.
`private boolean`	`required`	This is used to represent whether the entity is required or not.
`private boolean`	`text`	This is used to determine if this label represents text.
`private java.lang.Class`	`type`	This is used to represent the label class that this will use.
`private boolean`	`union`	This is used to determine if the label represents a union.

Constructor Summary

Constructors
Constructor Description

CacheLabel(Label label)
Constructor for the CacheLabel object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.annotation.Annotation`	`getAnnotation()`	This acquires the annotation associated with this label.
`Contact`	`getContact()`	This is used to acquire the contact object for this label.
`Converter`	`getConverter(Context context)`	This method returns a `Converter` which can be used to convert an XML node into an object value and vice versa.
`Decorator`	`getDecorator()`	This is used to acquire the `Decorator` for this.
`Type`	`getDependent()`	This returns the dependent type for the annotation.
`java.lang.Object`	`getEmpty(Context context)`	This is used to provide a configured empty value used when the annotated value is null.
`java.lang.String`	`getEntry()`	This is used to either provide the entry value provided within the annotation or compute a entry value.
`Expression`	`getExpression()`	This method is used to return an XPath expression that is used to represent the position of this label.
`java.lang.Object`	`getKey()`	This is the key used to represent this label.
`Label`	`getLabel(java.lang.Class type)`	This is used to acquire the `Label` that the type provided is represented by.
`java.lang.String`	`getName()`	This is used to acquire the name of the element or attribute that is used by the class schema.
`java.lang.String[]`	`getNames()`	This returns a `Collection` of element names.
`java.lang.String`	`getOverride()`	This is used to acquire the name of the element or attribute as taken from the annotation.
`java.lang.String`	`getPath()`	This is used to acquire the path of the element or attribute that is used by the class schema.
`java.lang.String[]`	`getPaths()`	This returns a `Collection` of element paths.
`java.lang.Class`	`getType()`	This acts as a convenience method used to determine the type of the field this represents.
`Type`	`getType(java.lang.Class type)`	This is used to acquire the `Type` that the type provided is represented by.
`boolean`	`isAttribute()`	This method is used to determine if the label represents an attribute.
`boolean`	`isCollection()`	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`	`isRequired()`	Determines whether the XML attribute or element is required.
`boolean`	`isText()`	This is used to determine if the label represents text.
`boolean`	`isTextList()`	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.
`java.lang.String`	`toString()`	This is used to describe the annotation and method or field that this label represents.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - annotation
```
private final java.lang.annotation.Annotation annotation
```
    This is the annotation that this label instance represents.
  - expression
```
private final Expression expression
```
    This is the expression that is used to represent this label.
  - decorator
```
private final Decorator decorator
```
    This is the decorator that is associated with the label.
  - contact
```
private final Contact contact
```
    This is the contact used to set and get the value for the node.
  - names
```
private final java.lang.String[] names
```
    This represents the names that identify this label instance.
  - paths
```
private final java.lang.String[] paths
```
    This represents the paths that identify this label instance.
  - type
```
private final java.lang.Class type
```
    This is used to represent the label class that this will use.
  - entry
```
private final java.lang.String entry
```
    This is used to represent the name of the entry item use.
  - path
```
private final java.lang.String path
```
    This represents the path location within the XML for this.
  - override
```
private final java.lang.String override
```
    This is used to represent the name override for the annotation.
  - name
```
private final java.lang.String name
```
    This is used to represent the name of the annotated element.
  - label
```
private final Label label
```
    This is the label the this cache is wrapping the values for.
  - key
```
private final java.lang.Object key
```
    This is the key is used to represent this label object.
  - depend
```
private final Type depend
```
    This is used to represent the dependent type to be used.
  - data
```
private final boolean data
```
    This is used to represent whether the data is written as data.
  - text
```
private final boolean text
```
    This is used to determine if this label represents text.
  - union
```
private final boolean union
```
    This is used to determine if the label represents a union.
  - attribute
```
private final boolean attribute
```
    This is used to determine the styling of the label name.
  - required
```
private final boolean required
```
    This is used to represent whether the entity is required or not.
  - collection
```
private final boolean collection
```
    This is used to determine if the label represents a collection.
  - inline
```
private final boolean inline
```
    This is used to determine whether the entity is inline or not.
  - list
```
private final boolean list
```
    This is used to determine if the label represents a text list.
- Constructor Detail
  - CacheLabel
```
public CacheLabel(Label label)
           throws java.lang.Exception
```
    Constructor for the CacheLabel object. This is used to create a Label that acquires details from another label in such a way that any logic involved in acquiring details is performed only once.
    
    Parameters:
    
    label - this is the label to acquire the details from
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - getType
```
public Type getType(java.lang.Class type)
             throws java.lang.Exception
```
    This is used to acquire the Type 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.
    
    Specified by:
    
    getType in interface Label
    
    Parameters:
    
    type - this is the class to acquire the type for
    
    Returns:
    
    this returns the type represented by this class
    
    Throws:
    
    java.lang.Exception
  - getLabel
```
public Label getLabel(java.lang.Class type)
               throws java.lang.Exception
```
    This is used to acquire the Label 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.
    
    Specified by:
    
    getLabel in interface Label
    
    Parameters:
    
    type - this is the type to acquire the label for
    
    Returns:
    
    this returns the label represented by this type
    
    Throws:
    
    java.lang.Exception
  - getNames
```
public java.lang.String[] getNames()
                            throws java.lang.Exception
```
    This returns a Collection 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.
    
    Specified by:
    
    getNames in interface Label
    
    Returns:
    
    this returns the names of each of the elements
    
    Throws:
    
    java.lang.Exception
  - getPaths
```
public java.lang.String[] getPaths()
                            throws java.lang.Exception
```
    This returns a Collection of element paths. This will typically contain only the path of the label, which is composed using the Path annotation and the name of the label. However, if this is a union it can contain many paths. This method should never return null.
    
    Specified by:
    
    getPaths in interface Label
    
    Returns:
    
    this returns the names of each of the elements
    
    Throws:
    
    java.lang.Exception
  - getAnnotation
```
public java.lang.annotation.Annotation 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 interface Label
    
    Returns:
    
    this returns the annotation that this represents
  - getContact
```
public Contact 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 interface Label
    
    Returns:
    
    returns the field that this label is representing
  - getDecorator
```
public Decorator getDecorator()
                       throws java.lang.Exception
```
    This is used to acquire the Decorator 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 interface Label
    
    Returns:
    
    this returns the decorator associated with this
    
    Throws:
    
    java.lang.Exception
  - getConverter
```
public Converter getConverter(Context context)
                       throws java.lang.Exception
```
    This method returns a Converter 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 interface Label
    
    Parameters:
    
    context - this is the context object for the serialization
    
    Returns:
    
    this returns an object that is used for conversion
    
    Throws:
    
    java.lang.Exception
  - getEmpty
```
public java.lang.Object getEmpty(Context context)
                          throws java.lang.Exception
```
    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.
    
    Specified by:
    
    getEmpty in interface Label
    
    Parameters:
    
    context - this is the context object for the serialization
    
    Returns:
    
    this returns the string to use for default values
    
    Throws:
    
    java.lang.Exception
  - getDependent
```
public Type getDependent()
                  throws java.lang.Exception
```
    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 the ElementList and the ElementArray this is the component type that is deserialized individually and inserted into the container.
    
    Specified by:
    
    getDependent in interface Label
    
    Returns:
    
    this is the type that the annotation depends on
    
    Throws:
    
    java.lang.Exception
  - getKey
```
public java.lang.Object getKey()
                        throws java.lang.Exception
```
    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.
    
    Specified by:
    
    getKey in interface Label
    
    Returns:
    
    this is the key used to represent the label
    
    Throws:
    
    java.lang.Exception
  - getEntry
```
public java.lang.String getEntry()
                          throws java.lang.Exception
```
    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.
    
    Specified by:
    
    getEntry in interface Label
    
    Returns:
    
    this returns the name of the XML entry element used
    
    Throws:
    
    java.lang.Exception
  - getName
```
public java.lang.String getName()
                         throws java.lang.Exception
```
    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.
    
    Specified by:
    
    getName in interface Label
    
    Returns:
    
    returns the name that is used for the XML property
    
    Throws:
    
    java.lang.Exception
  - getPath
```
public java.lang.String getPath()
                         throws java.lang.Exception
```
    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.
    
    Specified by:
    
    getPath in interface Label
    
    Returns:
    
    returns the path that is used for the XML property
    
    Throws:
    
    java.lang.Exception
  - getExpression
```
public Expression getExpression()
                         throws java.lang.Exception
```
    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 interface Label
    
    Returns:
    
    the XPath expression identifying the location
    
    Throws:
    
    java.lang.Exception
  - getOverride
```
public java.lang.String 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 interface Label
    
    Returns:
    
    returns the name of the annotation for the contact
  - getType
```
public java.lang.Class 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 a class 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.
    
    Specified by:
    
    getType in interface Label
    
    Returns:
    
    this returns the type of the field class
  - 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.
    
    Specified by:
    
    isData in interface Label
    
    Returns:
    
    this returns true if the element requires CDATA
  - 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.
    
    Specified by:
    
    isText in interface Label
    
    Returns:
    
    this returns true if this label represents text
  - 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 interface Label
    
    Returns:
    
    returns true if the label represents a text list
  - isInline
```
public boolean isInline()
```
    This is used to determine whether the label represents an inline XML entity. The ElementList annotation and the Text annotation represent inline items. This means that they contain no containing element and so can not specify overrides or special attributes.
    
    Specified by:
    
    isInline in interface Label
    
    Returns:
    
    this returns true if the annotation is inline
  - 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 interface Label
    
    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 interface Label
    
    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 interface Label
    
    Returns:
    
    true if the label represents a some required data
  - 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.
    
    Specified by:
    
    isUnion in interface Label
    
    Returns:
    
    this returns true if the label represents a union
  - toString
```
public java.lang.String 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.
    
    Specified by:
    
    toString in interface Label
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    this returns a string representation of the label

Class CacheLabel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

annotation

expression

decorator

contact

names

paths

type

entry

path

override

name

label

key

depend

data

text

union

attribute

required

collection

inline

list

Constructor Detail

CacheLabel

Method Detail

getType

getLabel

getNames

getPaths

getAnnotation

getContact

getDecorator

getConverter

getEmpty

getDependent

getKey

getEntry

getName

getPath

getExpression

getOverride

getType

isData

isText

isTextList

isInline

isAttribute

isCollection

isRequired

isUnion

toString