EE4J 10.0.0 · jakarta.xml.bind.JAXBElement

Jakarta XML Binding 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 attribute(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 Jakarta XML Binding 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 and Inner Type Summary

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

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

Constructor Summary

Access	Constructor and Description
public	JAXBElement(QName Java binding of xml element tag name name, Class<T> Java binding of xml element declaration's type declaredType, Class<?> Java binding of scope of xml element declaration. Passing null is the same as passing `GlobalScope.class` scope, T Java instance representing xml element's value. value) Construct an xml element instance.
public	JAXBElement(QName name, Class<T> declaredType, T value) Construct an xml element instance.

Method Summary

Modifier and Type	Method and Description
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<?>	Returns: `GlobalScope.class` if this element is of global scope. getScope() Returns scope of xml element declaration.
public T	getValue() Return the content model and attribute values for this element.
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.
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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

declaredType	back to summary
protected final Class<T> declaredType Java datatype binding for xml element declaration's type.

name	back to summary
protected final QName name xml element tag name

nil	back to summary
protected boolean nil true iff the xml element instance has xsi:nil="true".

scope	back to summary
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.

serialVersionUID	back to summary
private static final long serialVersionUID

value	back to summary
protected T value xml element value. Represents content model and attributes of an xml element instance.

Constructor Detail

JAXBElement back to summary

JAXBElement	back to summary
public JAXBElement(QName name, Class<T> declaredType, Class<?> scope, T value) Construct an xml element instance. Parameters name:QName Java binding of xml element tag name declaredType:Class<T> Java binding of xml element declaration's type scope:Class<?> Java binding of scope of xml element declaration. Passing null is the same as passing `GlobalScope.class` value:T Java instance representing xml element's value. See Also `getScope()`, `isTypeSubstituted()`

public JAXBElement(QName name, Class<T> declaredType, Class<?> scope, T value)

Construct an xml element instance.

Parameters

name:QName: Java binding of xml element tag name
declaredType:Class<T>: Java binding of xml element declaration's type
scope:Class<?>: Java binding of scope of xml element declaration. Passing null is the same as passing GlobalScope.class
value:T: Java instance representing xml element's value.

See Also

getScope(), isTypeSubstituted()

JAXBElement	back to summary
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)`

Method Detail

getDeclaredType	back to summary
public Class<T> getDeclaredType() Returns the Java binding of the xml element declaration's type attribute.

getName	back to summary
public QName getName() Returns the xml element tag name.

getScope back to summary

getScope	back to summary
public Class<?> getScope() Returns scope of xml element declaration. Returns:Class<?> `GlobalScope.class` if this element is of global scope. See Also `isGlobalScope()`

public Class<?> getScope()

Returns scope of xml element declaration.

Returns:Class<?>: GlobalScope.class if this element is of global scope.
See Also: isGlobalScope()

getValue back to summary

getValue	back to summary
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 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

isGlobalScope	back to summary
public boolean isGlobalScope() Returns true iff this xml element declaration is global.

isNil back to summary

isNil	back to summary
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 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).

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

setNil back to summary

setNil	back to summary
public void setNil(boolean value) Set whether this element has nil content. See Also `isNil()`

public void setNil(boolean value)

Set whether this element has nil content.

See Also: isNil()

setValue back to summary

setValue	back to summary
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()`

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()

public Class JAXBElement<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class JAXBElement.GlobalScope

Constructor Summary

Method Summary

Constructor Detail