• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/core/ElementPropertyInfo.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/core/ElementPropertyInfo.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.bind.v2.model.core;
aoqi@0	27
aoqi@0	28	import java.util.List;
aoqi@0	29
aoqi@0	30	import javax.xml.namespace.QName;
aoqi@0	31
aoqi@0	32	/**
aoqi@0	33	* Property that maps to an element.
aoqi@0	34	*
aoqi@0	35	* @author Kohsuke Kawaguchi
aoqi@0	36	*/
aoqi@0	37	// TODO: there seems to be too much interactions between switches, and that's no good.
aoqi@0	38	public interface ElementPropertyInfo<T,C> extends PropertyInfo<T,C> {
aoqi@0	39	/**
aoqi@0	40	* Returns the information about the types allowed in this property.
aoqi@0	41	*
aoqi@0	42	* <p>
aoqi@0	43	* In a simple case like the following, an element property only has
aoqi@0	44	* one {@link TypeRef} that points to {@link String} and tag name "foo".
aoqi@0	45	* <pre>
aoqi@0	46	* &#64;XmlElement
aoqi@0	47	* String abc;
aoqi@0	48	* </pre>
aoqi@0	49	*
aoqi@0	50	* <p>
aoqi@0	51	* However, in a general case an element property can be heterogeneous,
aoqi@0	52	* meaning you can put different types in it, each with a different tag name
aoqi@0	53	* (and a few other settings.)
aoqi@0	54	* <pre>
aoqi@0	55	* // list can contain String or Integer.
aoqi@0	56	* &#64;XmlElements({
aoqi@0	57	* &#64;XmlElement(name="a",type=String.class),
aoqi@0	58	* &#64;XmlElement(name="b",type=Integer.class),
aoqi@0	59	* })
aoqi@0	60	* List&lt;Object> abc;
aoqi@0	61	* </pre>
aoqi@0	62	* <p>
aoqi@0	63	* In this case this method returns a list of two {@link TypeRef}s.
aoqi@0	64	*
aoqi@0	65	*
aoqi@0	66	* @return
aoqi@0	67	* Always non-null. Contains at least one entry.
aoqi@0	68	* If {@link #isValueList()}==true, there's always exactly one type.
aoqi@0	69	*/
aoqi@0	70	List<? extends TypeRef<T,C>> getTypes();
aoqi@0	71
aoqi@0	72	/**
aoqi@0	73	* Gets the wrapper element name.
aoqi@0	74	*
aoqi@0	75	* @return
aoqi@0	76	* must be null if {@link #isCollection()}==false or
aoqi@0	77	* if {@link #isValueList()}==true.
aoqi@0	78	*
aoqi@0	79	* Otherwise,
aoqi@0	80	* this can be null (in which case there'll be no wrapper),
aoqi@0	81	* or it can be non-null (in which case there'll be a wrapper)
aoqi@0	82	*/
aoqi@0	83	QName getXmlName();
aoqi@0	84
aoqi@0	85	/**
aoqi@0	86	* Checks if the wrapper element is required.
aoqi@0	87	*
aoqi@0	88	* @return
aoqi@0	89	* Always false if {@link #getXmlName()}==null.
aoqi@0	90	*/
aoqi@0	91	boolean isCollectionRequired();
aoqi@0	92
aoqi@0	93	/**
aoqi@0	94	* Returns true if this property is nillable
aoqi@0	95	* (meaning the absence of the value is treated as nil='true')
aoqi@0	96	*
aoqi@0	97	* <p>
aoqi@0	98	* This method is only used when this property is a collection.
aoqi@0	99	*/
aoqi@0	100	boolean isCollectionNillable();
aoqi@0	101
aoqi@0	102	/**
aoqi@0	103	* Returns true if this property is a collection but its XML
aoqi@0	104	* representation is a list of values, not repeated elements.
aoqi@0	105	*
aoqi@0	106	* <p>
aoqi@0	107	* If {@link #isCollection()}==false, this property is always false.
aoqi@0	108	*
aoqi@0	109	* <p>
aoqi@0	110	* When this flag is true, <tt>getTypes().size()==1</tt> always holds.
aoqi@0	111	*/
aoqi@0	112	boolean isValueList();
aoqi@0	113
aoqi@0	114	/**
aoqi@0	115	* Returns true if this element is mandatory.
aoqi@0	116	*
aoqi@0	117	* For collections, this property isn't used.
aoqi@0	118	* TODO: define the semantics when this is a collection
aoqi@0	119	*/
aoqi@0	120	boolean isRequired();
aoqi@0	121
aoqi@0	122	Adapter<T,C> getAdapter();
aoqi@0	123	}