Class JAXBElement<T>
- java.lang.Object
-
- javax.xml.bind.JAXBElement<T>
-
- All Implemented Interfaces:
- Serializable
public class JAXBElement<T> 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.GlobalScopeor 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 and Description static classJAXBElement.GlobalScopeDesignates global scope for an xml element.
-
Field Summary
Fields Modifier and Type Field and Description protected Class<T>declaredTypeJava datatype binding for xml element declaration's type.protected QNamenamexml element tag nameprotected booleanniltrue iff the xml element instance has xsi:nil="true".protected ClassscopeScope of xml element declaration representing this xml element instance.protected Tvaluexml element value.
-
Constructor Summary
Constructors Constructor and 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 and Description Class<T>getDeclaredType()Returns the Java binding of the xml element declaration's type attribute.QNamegetName()Returns the xml element tag name.ClassgetScope()Returns scope of xml element declaration.TgetValue()Return the content model and attribute values for this element.booleanisGlobalScope()Returns true iff this xml element declaration is global.booleanisNil()Returns true iff this element instance content model is nil.booleanisTypeSubstituted()Returns true iff this xml element instance's value has a different type than xml element declaration's declared type.voidsetNil(boolean value)Set whether this element has nil content.voidsetValue(T t)Set the content model and attributes of this xml element.
-
-
-
Field Detail
name
protected final QName name
xml element tag name
declaredType
protected final Class<T> declaredType
Java datatype binding for xml element declaration's type.
scope
protected final Class scope
Scope of xml element declaration representing this xml element instance. Can be one of the following values: -JAXBElement.GlobalScopefor 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 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 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. - See Also:
-
getScope(),isTypeSubstituted()
-
Method Detail
getDeclaredType
public Class<T> getDeclaredType()
Returns the Java binding of the xml element declaration's type attribute.
getName
public QName getName()
Returns the xml element tag name.
setValue
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().- See Also:
-
isTypeSubstituted()
getValue
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
getScope
public Class getScope()
Returns scope of xml element declaration.- Returns:
- GlobalScope.class if this element is of global scope.
- See Also:
-
isGlobalScope()
isNil
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).
setNil
public void setNil(boolean value)
Set whether this element has nil content.
- See Also:
-
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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
