Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Variable.java December 2007
*
* Copyright (C) 2007, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml.core;
import org.simpleframework.xml.stream.InputNode;
import org.simpleframework.xml.stream.OutputNode;
import org.simpleframework.xml.stream.Position;
import org.simpleframework.xml.stream.Style;
/**
* 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.
*
* @author Niall Gallagher
*
* @see org.simpleframework.xml.core.Collector
*/
class Variable implements Label {
/**
* This is the object that has been deserialized from the XML.
*/
private final Object value;
/**
* This contains the details for the annotated field or method.
*/
private final Label label;
/**
* Constructor for the Variable 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.
*
* @param label this is the label for the field or method used
* @param value the deserialized object for the method or field
*/
public Variable(Label label, Object value) {
this.label = label;
this.value = value;
}
/**
* 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 the Converter is acquired a second time.
*
* @return this returns the value that has been deserialized
*/
public Object getValue() {
return value;
}
/**
* 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.
*
* @return this returns the decorator associated with this
*/
public Decorator getDecorator() throws Exception {
return label.getDecorator();
}
/**
* 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.
*
* @param context this is the context object for the serialization
*
* @return this returns an object that is used for conversion
*/
public Converter getConverter(Context context) throws Exception {
Converter reader = label.getConverter(context);
if(reader instanceof Adapter) {
return reader;
}
return new Adapter(reader, value);
}
/**
* 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.
*
* @param context this is the context used to style the name
*
* @return returns the name that is used for the XML property
*/
public String getName(Context context) throws Exception{
String name = label.getName(context);
Style style = context.getStyle();
return style.getElement(name);
}
/**
* 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.
*
* @param context this is the context object for the serialization
*
* @return this returns the string to use for default values
*/
public Object getEmpty(Context context) throws Exception {
return label.getEmpty(context);
}
/**
* 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.
*
* @return returns the field that this label is representing
*/
public Contact getContact() {
return label.getContact();
}
/**
* 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.
*
* @return this is the type that the annotation depends on
*/
public Class getDependent() throws Exception {
return label.getDependent();
}
/**
* 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.
*
* @return this returns the name of the XML entry element used
*/
public String getEntry() throws Exception {
return label.getEntry();
}
/**
* 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.
*
* @return returns the name that is used for the XML property
*/
public String getName() throws Exception{
return label.getName();
}
/**
* 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.
*
* @return returns the name of the annotation for the contact
*/
public String getOverride() {
return label.getOverride();
}
/**
* 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.
*
* @return this returns the type of the field class
*/
public Class getType() {
return label.getType();
}
/**
* 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.
*
* @return this returns true if the element requires CDATA
*/
public boolean isData() {
return label.isData();
}
/**
* 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.
*
* @return this returns true if the annotation is inline
*/
public boolean isInline() {
return label.isInline();
}
/**
* 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.
*
* @return this is used to determine if this is an attribute
*/
public boolean isAttribute() {
return label.isAttribute();
}
/**
* 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.
*
* @return true if the label represents a collection value
*/
public boolean isCollection() {
return label.isCollection();
}
/**
* 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.
*
* @return true if the label represents a some required data
*/
public boolean isRequired() {
return label.isRequired();
}
/**
* 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.
*
* @return this returns a string representation of the label
*/
public String toString() {
return label.toString();
}
/**
* The Adapter object is used to call the repeater
* with the original deserialized object. Using this object the
* converter interface can be used to perform repeat reads for
* the object. This must be given a Repeater in
* order to invoke the repeat read method.
*
* @author Niall Gallagher
*/
private class Adapter implements Repeater {
/**
* This is the converter object used to perform a repeat read.
*/
private final Converter reader;
/**
* This is the originally deserialized object value to use.
*/
private final Object value;
/**
* Constructor for the Adapter object. This will
* create an adapter between the converter an repeater such
* that the reads will read from the XML to the original.
*
* @param reader this is the converter object to be used
* @param value this is the originally deserialized object
*/
public Adapter(Converter reader, Object value) {
this.reader = reader;
this.value = value;
}
/**
* This read method will perform a read using the
* provided object with the repeater. Reading with this method
* ensures that any additional XML elements within the source
* will be added to the value.
*
* @param node this is the node that contains the extra data
*
* @return this will return the original deserialized object
*/
public Object read(InputNode node)throws Exception {
return read(node, value);
}
/**
* This read method will perform a read using the
* provided object with the repeater. Reading with this method
* ensures that any additional XML elements within the source
* will be added to the value.
*
* @param node this is the node that contains the extra data
*
* @return this will return the original deserialized object
*/
public Object read(InputNode node, Object value) throws Exception {
Position line = node.getPosition();
String name = node.getName();
if(reader instanceof Repeater) {
Repeater repeat = (Repeater) reader;
return repeat.read(node, value);
}
throw new PersistenceException("Element '%s' declared twice at %s", name, line);
}
/**
* This read method will perform a read using the
* provided object with the repeater. Reading with this method
* ensures that any additional XML elements within the source
* will be added to the value.
*
* @param node this is the node that contains the extra data
*
* @return this will return the original deserialized object
*/
public boolean validate(InputNode node) throws Exception {
Position line = node.getPosition();
String name = node.getName();
if(reader instanceof Repeater) {
Repeater repeat = (Repeater) reader;
return repeat.validate(node);
}
throw new PersistenceException("Element '%s' declared twice at %s", name, line);
}
/**
* This write method acts like any other write
* in that it passes on the node and source object to write.
* Typically this will not be used as the repeater object is
* used for repeat reads of scattered XML elements.
*
* @param node this is the node to write the data to
* @param value this is the source object to be written
*/
public void write(OutputNode node, Object value) throws Exception {
write(node, value);
}
}
}
