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

src/share/jaxws_classes/com/sun/xml/internal/ws/api/BindingIDFactory.java@f50545b5e2f1 (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/BindingIDFactory.java

Tue, 06 Mar 2012 16:09:35 -0800

author

ohair

date

Tue, 06 Mar 2012 16:09:35 -0800

changeset 286

f50545b5e2f1

child 368

0989ad8c0860

permissions

-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

ohair@286	1	/*
ohair@286	2	* Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286	4	*
ohair@286	5	* This code is free software; you can redistribute it and/or modify it
ohair@286	6	* under the terms of the GNU General Public License version 2 only, as
ohair@286	7	* published by the Free Software Foundation. Oracle designates this
ohair@286	8	* particular file as subject to the "Classpath" exception as provided
ohair@286	9	* by Oracle in the LICENSE file that accompanied this code.
ohair@286	10	*
ohair@286	11	* This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286	14	* version 2 for more details (a copy is included in the LICENSE file that
ohair@286	15	* accompanied this code).
ohair@286	16	*
ohair@286	17	* You should have received a copy of the GNU General Public License version
ohair@286	18	* 2 along with this work; if not, write to the Free Software Foundation,
ohair@286	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286	20	*
ohair@286	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286	22	* or visit www.oracle.com if you need additional information or have any
ohair@286	23	* questions.
ohair@286	24	*/
ohair@286	25
ohair@286	26	package com.sun.xml.internal.ws.api;
ohair@286	27
ohair@286	28	import com.sun.istack.internal.Nullable;
ohair@286	29	import com.sun.istack.internal.NotNull;
ohair@286	30
ohair@286	31	import javax.xml.ws.WebServiceException;
ohair@286	32
ohair@286	33	/**
ohair@286	34	* Extension point to plug in additional {@link BindingID} parsing logic.
ohair@286	35	*
ohair@286	36	* <p>
ohair@286	37	* When the JAX-WS RI is asked to parse a binding ID string into a {@link BindingID}
ohair@286	38	* object, it uses service idiom to look for the implementations of this class
ohair@286	39	* in the <tt>META-INF/services/...</tt>.
ohair@286	40	*
ohair@286	41	* @since JAX-WS 2.0.next
ohair@286	42	* @author Kohsuke Kawaguchi
ohair@286	43	* @see BindingID#parse(String)
ohair@286	44	*/
ohair@286	45	public abstract class BindingIDFactory {
ohair@286	46	/**
ohair@286	47	* Parses a binding ID string into {@link BindingID} if possible.
ohair@286	48	*
ohair@286	49	* @return
ohair@286	50	* a non-null return value would cause the JAX-WS RI to consider
ohair@286	51	* the parsing to be successful. No furhter {@link BindingIDFactory}
ohair@286	52	* will be consulted.
ohair@286	53	*
ohair@286	54	* <p>
ohair@286	55	* Retruning a null value indicates that this factory doesn't understand
ohair@286	56	* this string, in which case the JAX-WS RI will keep asking next
ohair@286	57	* {@link BindingIDFactory}.
ohair@286	58	*
ohair@286	59	* @throws WebServiceException
ohair@286	60	* if the implementation understood the lexical value but it is not correct,
ohair@286	61	* this exception can be thrown to abort the parsing with error.
ohair@286	62	* No further {@link BindingIDFactory} will be consulted, and
ohair@286	63	* {@link BindingID#parse(String)} will throw the exception.
ohair@286	64	*/
ohair@286	65	public abstract @Nullable BindingID parse(@NotNull String lexical) throws WebServiceException;
ohair@286	66	}