Home » xml-commons-external-1.4.01-src » javax » xml » bind » [javadoc | source]
javax.xml.bind
public class: JAXBElement [javadoc | source]
java.lang.Object
   javax.xml.bind.JAXBElement

All Implemented Interfaces:
    Serializable

JAXB representation of an Xml Element.

This class represents information about an Xml Element from both the element declaration within a schema and the element instance value within an xml document with the following properties

The declaredType and scope property are the JAXB class binding for the xml type definition.

Scope is either GlobalScope or the Java class representing the complex type definition containing the schema element declaration.

There is a property constraint that if value is null, then nil must be true. The converse is not true to enable representing a nil element with attribute(s). If nil is true, it is possible that value is non-null so it can hold the value of the attributes associated with a nil element.

Nested Class Summary:
public static final class  JAXBElement.GlobalScope  Designates global scope for an xml element. 
Field Summary
protected final  QName name    xml element tag name 
protected final  Class<T> declaredType    Java datatype binding for xml element declaration's type. 
protected final  Class scope    Scope of xml element declaration representing this xml element instance. Can be one of the following values: - GlobalScope for global xml element declaration. - local element declaration has a scope set to the Java class representation of complex type defintion containing xml element declaration. 
protected  T value    xml element value. Represents content model and attributes of an xml element instance. 
protected  boolean nil    true iff the xml element instance has xsi:nil="true". 
Constructor:
 public JAXBElement(QName name,
    Class<T> declaredType,
    T value) 
    Construct an xml element instance. This is just a convenience method for new JAXBElement(name,declaredType,GlobalScope.class,value)
 public JAXBElement(QName name,
    Class<T> declaredType,
    Class scope,
    T value) 

    Construct an xml element instance.

    Parameters:
    name - Java binding of xml element tag name
    declaredType - Java binding of xml element declaration's type
    scope - Java binding of scope of xml element declaration. Passing null is the same as passing GlobalScope.class
    value - Java instance representing xml element's value.
    Also see:
    getScope()
    isTypeSubstituted()
Method from javax.xml.bind.JAXBElement Summary:
getDeclaredType,   getName,   getScope,   getValue,   isGlobalScope,   isNil,   isTypeSubstituted,   setNil,   setValue
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.bind.JAXBElement Detail:
 public Class<T> getDeclaredType() 
    Returns the Java binding of the xml element declaration's type attribute.
 public QName getName() 
    Returns the xml element tag name.
 public Class getScope() 
    Returns scope of xml element declaration.
 public T getValue() 

    Return the content model and attribute values for this element.

    See #isNil() for a description of a property constraint when this value is null

 public boolean isGlobalScope() 
    Returns true iff this xml element declaration is global.
 public boolean isNil() 

    Returns true iff this element instance content model is nil.

    This property always returns true when #getValue() is null. Note that the converse is not true, when this property is true, #getValue() can contain a non-null value for attribute(s). It is valid for a nil xml element to have attribute(s).

 public boolean isTypeSubstituted() 
    Returns true iff this xml element instance's value has a different type than xml element declaration's declared type.
 public  void setNil(boolean value) 

    Set whether this element has nil content.

 public  void setValue(T t) 

    Set the content model and attributes of this xml element.

    When this property is set to null, isNil() must by true. Details of constraint are described at #isNil() .