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

src/share/jaxws_classes/com/sun/xml/internal/xsom/XSIdentityConstraint.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/xsom/XSIdentityConstraint.java

Thu, 12 Oct 2017 19:44:07 +0800

author

aoqi

date

Thu, 12 Oct 2017 19:44:07 +0800

changeset 760

e530533619ec

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2010, 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.xsom;
aoqi@0	27
aoqi@0	28	import java.util.List;
aoqi@0	29
aoqi@0	30	/**
aoqi@0	31	* Identity constraint.
aoqi@0	32	*
aoqi@0	33	* @author Kohsuke Kawaguchi
aoqi@0	34	*/
aoqi@0	35	public interface XSIdentityConstraint extends XSComponent {
aoqi@0	36
aoqi@0	37	/**
aoqi@0	38	* Gets the {@link XSElementDecl} that owns this identity constraint.
aoqi@0	39	*
aoqi@0	40	* @return
aoqi@0	41	* never null.
aoqi@0	42	*/
aoqi@0	43	XSElementDecl getParent();
aoqi@0	44
aoqi@0	45	/**
aoqi@0	46	* Name of the identity constraint.
aoqi@0	47	*
aoqi@0	48	* A name uniquely identifies this {@link XSIdentityConstraint} within
aoqi@0	49	* the namespace.
aoqi@0	50	*
aoqi@0	51	* @return
aoqi@0	52	* never null.
aoqi@0	53	*/
aoqi@0	54	String getName();
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Target namespace of the identity constraint.
aoqi@0	58	*
aoqi@0	59	* Just short for <code>getParent().getTargetNamespace()</code>.
aoqi@0	60	*/
aoqi@0	61	String getTargetNamespace();
aoqi@0	62
aoqi@0	63	/**
aoqi@0	64	* Returns the type of the identity constraint.
aoqi@0	65	*
aoqi@0	66	* @return
aoqi@0	67	* either {@link #KEY},{@link #KEYREF}, or {@link #UNIQUE}.
aoqi@0	68	*/
aoqi@0	69	short getCategory();
aoqi@0	70
aoqi@0	71	final short KEY = 0;
aoqi@0	72	final short KEYREF = 1;
aoqi@0	73	final short UNIQUE = 2;
aoqi@0	74
aoqi@0	75	/**
aoqi@0	76	* Returns the selector XPath expression as string.
aoqi@0	77	*
aoqi@0	78	* @return
aoqi@0	79	* never null.
aoqi@0	80	*/
aoqi@0	81	XSXPath getSelector();
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Returns the list of field XPaths.
aoqi@0	85	*
aoqi@0	86	* @return
aoqi@0	87	* a non-empty read-only list of {@link String}s,
aoqi@0	88	* each representing the XPath.
aoqi@0	89	*/
aoqi@0	90	List<XSXPath> getFields();
aoqi@0	91
aoqi@0	92	/**
aoqi@0	93	* If this is {@link #KEYREF}, returns the key {@link XSIdentityConstraint}
aoqi@0	94	* being referenced.
aoqi@0	95	*
aoqi@0	96	* @return
aoqi@0	97	* always non-null (when {@link #getCategory()}=={@link #KEYREF}).
aoqi@0	98	* @throws IllegalStateException
aoqi@0	99	* if {@link #getCategory()}!={@link #KEYREF}
aoqi@0	100	*/
aoqi@0	101	XSIdentityConstraint getReferencedKey();
aoqi@0	102	}