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

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

src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/core/ReferencePropertyInfo.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.Collection;
aoqi@0	29	import java.util.Set;
aoqi@0	30
aoqi@0	31	import javax.xml.namespace.QName;
aoqi@0	32
aoqi@0	33	/**
aoqi@0	34	* {@link PropertyInfo} that holds references to other {@link Element}s.
aoqi@0	35	*
aoqi@0	36	* @author Kohsuke Kawaguchi
aoqi@0	37	*/
aoqi@0	38	public interface ReferencePropertyInfo<T,C> extends PropertyInfo<T,C> {
aoqi@0	39	/**
aoqi@0	40	* Returns the information about the possible elements in this property.
aoqi@0	41	*
aoqi@0	42	* <p>
aoqi@0	43	* As of 2004/08/17, the spec only allows you to use different element names
aoqi@0	44	* when a property is a collection, but I think there's really no reason
aoqi@0	45	* to limit it there --- if the user wants to use a different tag name
aoqi@0	46	* for different objects, I don't see why this can be limited to collections.
aoqi@0	47	*
aoqi@0	48	* <p>
aoqi@0	49	* So this is a generalization of the spec. We always allow a property to have
aoqi@0	50	* multiple types and use different tag names for it, depending on the actual type.
aoqi@0	51	*
aoqi@0	52	* <p>
aoqi@0	53	* In most of the cases, this collection only contains 1 item. So the runtime system
aoqi@0	54	* is encouraged to provide a faster code-path that is optimized toward such cases.
aoqi@0	55	*
aoqi@0	56	* @return
aoqi@0	57	* Always non-null. Contains at least one entry.
aoqi@0	58	*/
aoqi@0	59	Set<? extends Element<T,C>> getElements();
aoqi@0	60
aoqi@0	61	/**
aoqi@0	62	* {@inheritDoc}.
aoqi@0	63	*
aoqi@0	64	* If this {@link ReferencePropertyInfo} has a wildcard in it,
aoqi@0	65	* then the returned list will contain {@link WildcardTypeInfo}.
aoqi@0	66	*/
aoqi@0	67	Collection<? extends TypeInfo<T,C>> ref();
aoqi@0	68
aoqi@0	69	/**
aoqi@0	70	* Gets the wrapper element name.
aoqi@0	71	*
aoqi@0	72	* @return
aoqi@0	73	* must be null if not collection. If the property is a collection,
aoqi@0	74	* this can be null (in which case there'll be no wrapper),
aoqi@0	75	* or it can be non-null (in which case there'll be a wrapper)
aoqi@0	76	*/
aoqi@0	77	QName getXmlName();
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Returns true if this property is nillable
aoqi@0	81	* (meaning the absence of the value is treated as nil='true')
aoqi@0	82	*
aoqi@0	83	* <p>
aoqi@0	84	* This method is only used when this property is a collection.
aoqi@0	85	*/
aoqi@0	86	boolean isCollectionNillable();
aoqi@0	87
aoqi@0	88	/**
aoqi@0	89	* Checks if the wrapper element is required.
aoqi@0	90	*
aoqi@0	91	* @return
aoqi@0	92	* Always false if {@link #getXmlName()}==null.
aoqi@0	93	*/
aoqi@0	94	boolean isCollectionRequired();
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* Returns true if this property can hold {@link String}s to represent
aoqi@0	98	* mixed content model.
aoqi@0	99	*/
aoqi@0	100	boolean isMixed();
aoqi@0	101
aoqi@0	102	/**
aoqi@0	103	* If this property supports the wildcard, returns its mode.
aoqi@0	104	*
aoqi@0	105	* @return null
aoqi@0	106	* if the wildcard is not allowed on this element.
aoqi@0	107	*/
aoqi@0	108	WildcardMode getWildcard();
aoqi@0	109
aoqi@0	110	/**
aoqi@0	111	* If this property supports the wildcard, returns its DOM handler.
aoqi@0	112	*
aoqi@0	113	* @return null
aoqi@0	114	* if the wildcard is not allowed on this element.
aoqi@0	115	*/
aoqi@0	116	C getDOMHandler();
aoqi@0	117
aoqi@0	118	/**
aoqi@0	119	* Returns true if this element is mandatory.
aoqi@0	120	*/
aoqi@0	121	boolean isRequired();
aoqi@0	122
aoqi@0	123	Adapter<T,C> getAdapter();
aoqi@0	124	}