diff -r 4ebc2e2fb97c -r 71c04702a3d5 src/java.xml.bind/share/classes/javax/xml/bind/JAXBElement.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/java.xml.bind/share/classes/javax/xml/bind/JAXBElement.java Tue Sep 12 19:03:39 2017 +0200 @@ -0,0 +1,218 @@ +/* + * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package javax.xml.bind; + +import javax.xml.namespace.QName; +import java.io.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 {@code declaredType} and {@code scope} property are the + * JAXB class binding for the xml type definition. + *
+ * + *{@code 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 {@code value} is {@code null}, + * then {@code nil} must be {@code true}. The converse is not true to enable + * representing a nil element with attribute(s). If {@code nil} is true, it is possible + * that {@code value} is non-null so it can hold the value of the attributes + * associated with a nil element. + *
+ * + * @author Kohsuke Kawaguchi, Joe Fialli + * @since 1.6, JAXB 2.0 + */ + +public class JAXBElementConstruct an xml element instance.
+ * + * @param name Java binding of xml element tag name + * @param declaredType Java binding of xml element declaration's type + * @param scope + * Java binding of scope of xml element declaration. + * Passing null is the same as passing {@code GlobalScope.class} + * @param value + * Java instance representing xml element's value. + * @see #getScope() + * @see #isTypeSubstituted() + */ + public JAXBElement(QName name, + ClassSet the content model and attributes of this xml element.
+ * + *When this property is set to {@code null}, {@code isNil()} must by {@code true}. + * Details of constraint are described at {@link #isNil()}.
+ * + * @see #isTypeSubstituted() + */ + public void setValue(T t) { + this.value = t; + } + + /** + *Return the content model and attribute values for this element.
+ * + *See {@link #isNil()} for a description of a property constraint when + * this value is {@code null}
+ */ + public T getValue() { + return value; + } + + /** + * Returns scope of xml element declaration. + * + * @see #isGlobalScope() + * @return {@code GlobalScope.class} if this element is of global scope. + */ + public Class getScope() { + return scope; + } + + /** + *Returns {@code true} iff this element instance content model + * is nil.
+ * + *This property always returns {@code true} when {@link #getValue()} is null. + * Note that the converse is not true, when this property is {@code 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 isNil() { + return (value == null) || nil; + } + + /** + *Set whether this element has nil content.
+ * + * @see #isNil() + */ + public void setNil(boolean value) { + this.nil = value; + } + + /* Convenience methods + * (Not necessary but they do unambiguously conceptualize + * the rationale behind this class' fields.) + */ + + /** + * Returns true iff this xml element declaration is global. + */ + public boolean isGlobalScope() { + return this.scope == GlobalScope.class; + } + + /** + * Returns true iff this xml element instance's value has a different + * type than xml element declaration's declared type. + */ + public boolean isTypeSubstituted() { + if(value==null) return false; + return value.getClass() != declaredType; + } + + private static final long serialVersionUID = 1L; +}