JAXBElement (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.xml.bind.JAXBElement

• All Implemented Interfaces:
  Serializable

public class JAXBElement
extends Object
implements 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

• element's xml tag name

• value represents the element instance's atttribute(s) and content model

• element declaration's declaredType (xs:element @type attribute)

• scope of element declaration

• boolean nil property. (element instance's xsi:nil attribute)
  The declaredType and scope property are the JAXB class binding for the xml type definition.
  Scope is either JAXBElement.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.
  Since:
  JAXB 2.0
  See Also:
  Serialized Form

• • Nested Class Summary

  Nested Classes

  Modifier and Type	Class	Description
  static class	JAXBElement.GlobalScope	Designates global scope for an xml element.

  • Field Summary

  Fields

  Modifier and Type	Field	Description
  protected Class<T>	declaredType	Java datatype binding for xml element declaration's type.
  protected QName	name	xml element tag name
  protected boolean	nil	true iff the xml element instance has xsi:nil="true".
  protected Class	scope	Scope of xml element declaration representing this xml element instance.
  protected T	value	xml element value.

  • Constructor Summary

  Constructors

  Constructor	Description
  JAXBElement(QName name,Class<T> declaredType,Class scope,T value)	Construct an xml element instance.
  JAXBElement(QName name,Class<T> declaredType,T value)	Construct an xml element instance.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  Class<T>	getDeclaredType()	Returns the Java binding of the xml element declaration's type attribute.
  QName	getName()	Returns the xml element tag name.
  Class	getScope()	Returns scope of xml element declaration.
  T	getValue()	Return the content model and attribute values for this element.
  boolean	isGlobalScope()	Returns true iff this xml element declaration is global.
  boolean	isNil()	Returns true iff this element instance content model is nil.
  boolean	isTypeSubstituted()	Returns true iff this xml element instance's value has a different type than xml element declaration's declared type.
  void	setNil(boolean value)	Set whether this element has nil content.
  void	setValue(T t)	Set the content model and attributes of this xml element.

     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### name  
     protected final [QName](../../../javax/xml/namespace/QName.html "class in javax.xml.namespace") name  
     xml element tag name  
     * #### declaredType  
     protected final [Class](../../../java/lang/Class.html "class in java.lang")<[T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement")> declaredType  
     Java datatype binding for xml element declaration's type.  
     * #### scope  
     protected final [Class](../../../java/lang/Class.html "class in java.lang") scope  
     Scope of xml element declaration representing this xml element instance. Can be one of the following values: - [JAXBElement.GlobalScope](../../../javax/xml/bind/JAXBElement.GlobalScope.html "class in javax.xml.bind") 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.  
     * #### value  
     protected [T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement") value  
     xml element value. Represents content model and attributes of an xml element instance.  
     * #### nil  
     protected boolean nil  
     true iff the xml element instance has xsi:nil="true".  

  • Constructor Detail

    * #### JAXBElement  
    public JAXBElement([QName](../../../javax/xml/namespace/QName.html "class in javax.xml.namespace") name,  
                       [Class](../../../java/lang/Class.html "class in java.lang")<[T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement")> declaredType,  
                       [Class](../../../java/lang/Class.html "class in java.lang") scope,  
                       [T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement") 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.  
    See Also:  
    [getScope()](../../../javax/xml/bind/JAXBElement.html#getScope--), [isTypeSubstituted()](../../../javax/xml/bind/JAXBElement.html#isTypeSubstituted--)  
    * #### JAXBElement  
    public JAXBElement([QName](../../../javax/xml/namespace/QName.html "class in javax.xml.namespace") name,  
                       [Class](../../../java/lang/Class.html "class in java.lang")<[T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement")> declaredType,  
                       [T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement") value)  
    Construct an xml element instance. This is just a convenience method for  
    new JAXBElement(name,declaredType,GlobalScope.class,value)  

  • Method Detail

    * #### getDeclaredType  
    public [Class](../../../java/lang/Class.html "class in java.lang")<[T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement")> getDeclaredType()  
    Returns the Java binding of the xml element declaration's type attribute.  
    * #### getName  
    public [QName](../../../javax/xml/namespace/QName.html "class in javax.xml.namespace") getName()  
    Returns the xml element tag name.  
    * #### setValue  
    public void setValue([T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement") 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()](../../../javax/xml/bind/JAXBElement.html#isNil--).  
    See Also:  
    [isTypeSubstituted()](../../../javax/xml/bind/JAXBElement.html#isTypeSubstituted--)  
    * #### getValue  
    public [T](../../../javax/xml/bind/JAXBElement.html "type parameter in JAXBElement") getValue()  
    Return the content model and attribute values for this element.  
    See [isNil()](../../../javax/xml/bind/JAXBElement.html#isNil--) for a description of a property constraint when this value is null  
    * #### getScope  
    public [Class](../../../java/lang/Class.html "class in java.lang") getScope()  
    Returns scope of xml element declaration.  
    Returns:  
    GlobalScope.class if this element is of global scope.  
    See Also:  
    [isGlobalScope()](../../../javax/xml/bind/JAXBElement.html#isGlobalScope--)  
    * #### isNil  
    public boolean isNil()  
    Returns true iff this element instance content model is nil.  
    This property always returns true when [getValue()](../../../javax/xml/bind/JAXBElement.html#getValue--) is null. Note that the converse is not true, when this property is true,[getValue()](../../../javax/xml/bind/JAXBElement.html#getValue--) can contain a non-null value for attribute(s). It is valid for a nil xml element to have attribute(s).  
    * #### setNil  
    public void setNil(boolean value)  
    Set whether this element has nil content.  
    See Also:  
    [isNil()](../../../javax/xml/bind/JAXBElement.html#isNil--)  
    * #### isGlobalScope  
    public boolean isGlobalScope()  
    Returns true iff this xml element declaration is global.  
    * #### isTypeSubstituted  
    public boolean isTypeSubstituted()  
    Returns true iff this xml element instance's value has a different type than xml element declaration's declared type.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.