ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: 
ohair@286: /**
ohair@286:  * Extended version of {@link Component}.  Allows component to return multiple
ohair@286:  * SPI implementations through an {@link Iterable}.
ohair@286:  *
ohair@286:  * @since 2.2.6
ohair@286:  */
ohair@286: public interface ComponentEx extends Component {
ohair@286:     /**
ohair@286:      * Gets an iterator of implementations of the specified SPI.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This method works as a kind of directory service
ohair@286:      * for SPIs, allowing various components to define private contract
alanb@368:      * and talk to each other.  However unlike {@link Component#getSPI(java.lang.Class)}, this
ohair@286:      * method can support cases where there is an ordered collection (defined
ohair@286:      * by {@link Iterable} of implementations.  The SPI contract should define
ohair@286:      * whether lookups are for the first appropriate implementation or whether
ohair@286:      * all returned implementations should be used.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      non-null {@link Iterable} of the SPI's provided by this object.  Iterator may have no values.
ohair@286:      */
ohair@286:     @NotNull <S> Iterable<S> getIterableSPI(@NotNull Class<S> spiType);
ohair@286: }