| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
The declaredType and scope property are the JAXB class binding for the xml type definition.
Scope is either {@link 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 | |
---|---|
static class |
Designates global scope for an xml element. |
Field Summary | |
---|---|
protected Class |
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 Object |
value
xml element value. |
Constructor Summary | |
---|---|
JAXBElement(QName name, Class declaredType, Class scope, Object value) Construct an xml element instance. |
|
JAXBElement(QName name, Class declaredType, Object value) Construct an xml element instance. |
Method Summary | |
---|---|
Class |
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. |
Object |
getValue() Return the content model and attribute values for this element. |
boolean |
Returns true iff this xml element declaration is global. |
boolean |
isNil() Returns true iff this element instance content model is nil. |
boolean |
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 |
Set the content model and attributes of this xml element. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Class declaredType
protected final QName name
protected boolean nil
protected final Class scope
protected Object value
Constructor Detail |
---|
public JAXBElement(QName name, Class declaredType, Class scope, Object value)
Construct an xml element instance.
name
- Java binding of xml element tag namedeclaredType
- Java binding of xml element declaration's typescope
- Java binding of scope of xml element declaration.
Passing null is the same as passing GlobalScope.classvalue
- Java instance representing xml element's value.public JAXBElement(QName name, Class declaredType, Object value)
name
declaredType
value
Method Detail |
---|
public Class getDeclaredType()
public QName getName()
public Class getScope()
public Object getValue()
Return the content model and attribute values for this element.
See {@link #isNil()} for a description of a property constraint when this value is null
public boolean isGlobalScope()
public boolean isNil()
Returns true iff this element instance content model is nil.
This property always returns true when {@link #getValue()} is null. Note that the converse is not true, when this property is true, {@link #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()
public void setNil(boolean value)
Set whether this element has nil content.
value
public void setValue(Object 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 {@link #isNil()}.
t
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |