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

Print this page


   1 /*
   2  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 
  30 /**
  31  * Extended version of {@link Component}.  Allows component to return multiple
  32  * SPI implementations through an {@link Iterable}.
  33  *
  34  * @since 2.2.6
  35  */
  36 public interface ComponentEx extends Component {
  37     /**
  38      * Gets an iterator of implementations of the specified SPI.
  39      *
  40      * <p>
  41      * This method works as a kind of directory service
  42      * for SPIs, allowing various components to define private contract
  43      * and talk to each other.  However unlike {@link Component.getSPI}, this
  44      * method can support cases where there is an ordered collection (defined
  45      * by {@link Iterable} of implementations.  The SPI contract should define
  46      * whether lookups are for the first appropriate implementation or whether
  47      * all returned implementations should be used.
  48      *
  49      * @return
  50      *      non-null {@link Iterable} of the SPI's provided by this object.  Iterator may have no values.
  51      */
  52     @NotNull <S> Iterable<S> getIterableSPI(@NotNull Class<S> spiType);
  53 }
   1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 
  30 /**
  31  * Extended version of {@link Component}.  Allows component to return multiple
  32  * SPI implementations through an {@link Iterable}.
  33  *
  34  * @since 2.2.6
  35  */
  36 public interface ComponentEx extends Component {
  37     /**
  38      * Gets an iterator of implementations of the specified SPI.
  39      *
  40      * <p>
  41      * This method works as a kind of directory service
  42      * for SPIs, allowing various components to define private contract
  43      * and talk to each other.  However unlike {@link Component#getSPI(java.lang.Class)}, this
  44      * method can support cases where there is an ordered collection (defined
  45      * by {@link Iterable} of implementations.  The SPI contract should define
  46      * whether lookups are for the first appropriate implementation or whether
  47      * all returned implementations should be used.
  48      *
  49      * @return
  50      *      non-null {@link Iterable} of the SPI's provided by this object.  Iterator may have no values.
  51      */
  52     @NotNull <S> Iterable<S> getIterableSPI(@NotNull Class<S> spiType);
  53 }