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

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

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

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

author

aoqi

date

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

changeset 637

9c07ef4934dd

parent 368

0989ad8c0860

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
aoqi@0	30	import javax.activation.MimeType;
aoqi@0	31	import javax.xml.bind.annotation.XmlID;
aoqi@0	32	import javax.xml.bind.annotation.XmlIDREF;
aoqi@0	33	import javax.xml.bind.annotation.XmlType;
aoqi@0	34	import javax.xml.bind.annotation.XmlSchemaType;
aoqi@0	35	import javax.xml.namespace.QName;
aoqi@0	36
aoqi@0	37	import com.sun.istack.internal.Nullable;
aoqi@0	38	import com.sun.xml.internal.bind.v2.model.annotation.AnnotationSource;
aoqi@0	39
aoqi@0	40	/**
aoqi@0	41	* Information about a JAXB-bound property.
aoqi@0	42	*
aoqi@0	43	* <p>
aoqi@0	44	* All the JAXB annotations are already incorporated into the model so that
aoqi@0	45	* the caller doesn't have to worry about reading them. For this reason, you
aoqi@0	46	* cannot access annotations on properties directly.
aoqi@0	47	*
aoqi@0	48	* TODO: don't we need a visitor?
aoqi@0	49	*
aoqi@0	50	* @author Kohsuke Kawaguchi
aoqi@0	51	*/
aoqi@0	52	public interface PropertyInfo<T,C> extends AnnotationSource {
aoqi@0	53
aoqi@0	54	/**
aoqi@0	55	* Gets the {@link ClassInfo} or {@link ElementInfo} to which this property belongs.
aoqi@0	56	*/
aoqi@0	57	TypeInfo<T,C> parent();
aoqi@0	58
aoqi@0	59	/**
aoqi@0	60	* Gets the name of the property.
aoqi@0	61	*
aoqi@0	62	* <p>
aoqi@0	63	* For example, "foo" or "bar".
aoqi@0	64	* Generally, a property name is different from XML,
aoqi@0	65	* (although they are often related, as a property name is often
aoqi@0	66	* computed from tag names / attribute names.)
aoqi@0	67	* In fact, <b>property names do not directly affect XML</b>.
aoqi@0	68	* The property name uniquely identifies a property within a class.
aoqi@0	69	*
aoqi@0	70	* @see XmlType#propOrder()
aoqi@0	71	*/
aoqi@0	72	String getName();
aoqi@0	73
aoqi@0	74	/**
aoqi@0	75	* Gets the display name of the property.
aoqi@0	76	*
aoqi@0	77	* <p>
aoqi@0	78	* This is a convenience method for
aoqi@0	79	* {@code parent().getName()+'#'+getName()}.
aoqi@0	80	*/
aoqi@0	81	String displayName();
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Returns true if this is a multi-valued collection property.
aoqi@0	85	* Otherwise false, in which case the property is a single value.
aoqi@0	86	*/
aoqi@0	87	boolean isCollection();
aoqi@0	88
aoqi@0	89	/**
aoqi@0	90	* List of {@link TypeInfo}s that this property references.
aoqi@0	91	*
aoqi@0	92	* This allows the caller to traverse the reference graph without
aoqi@0	93	* getting into the details of each different property type.
aoqi@0	94	*
aoqi@0	95	* @return
aoqi@0	96	* non-null read-only collection.
aoqi@0	97	*/
aoqi@0	98	Collection<? extends TypeInfo<T,C>> ref();
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Gets the kind of this property.
aoqi@0	102	*
aoqi@0	103	* @return
aoqi@0	104	* always non-null.
aoqi@0	105	*/
aoqi@0	106	PropertyKind kind();
aoqi@0	107
aoqi@0	108	/**
aoqi@0	109	* @return
aoqi@0	110	* null if the property is not adapted.
aoqi@0	111	*/
aoqi@0	112	Adapter<T,C> getAdapter();
aoqi@0	113
aoqi@0	114	/**
aoqi@0	115	* Returns the IDness of the value of this element.
aoqi@0	116	*
aoqi@0	117	* @see XmlID
aoqi@0	118	* @see XmlIDREF
aoqi@0	119	*
aoqi@0	120	* @return
aoqi@0	121	* always non-null
aoqi@0	122	*/
aoqi@0	123	ID id();
aoqi@0	124
aoqi@0	125	/**
aoqi@0	126	* Expected MIME type, if any.
aoqi@0	127	*/
aoqi@0	128	MimeType getExpectedMimeType();
aoqi@0	129
aoqi@0	130	/**
aoqi@0	131	* If this is true and this property indeed represents a binary data,
aoqi@0	132	* it should be always inlined.
aoqi@0	133	*/
aoqi@0	134	boolean inlineBinaryData();
aoqi@0	135
aoqi@0	136	/**
aoqi@0	137	* The effective value of {@link XmlSchemaType} annotation, if any.
aoqi@0	138	*
aoqi@0	139	* <p>
aoqi@0	140	* If the property doesn't have {@link XmlSchemaType} annotation,
aoqi@0	141	* this method returns null.
aoqi@0	142	*
aoqi@0	143	* <p>
aoqi@0	144	* Since a type name is a property of a Java type, not a Java property,
aoqi@0	145	* A schema type name of a Java type should be primarily obtained
aoqi@0	146	* by using {@link NonElement#getTypeName()}. This method is to correctly
aoqi@0	147	* implement the ugly semantics of {@link XmlSchemaType} (namely
aoqi@0	148	* when this returns non-null, it overrides the type names of all types
aoqi@0	149	* that are in this property.)
aoqi@0	150	*/
aoqi@0	151	@Nullable QName getSchemaType();
aoqi@0	152	}