javax.enterprise.inject.Instance Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javaee-16 Show documentation

JavaEE 1.6 API for Resin Java Application Server

There is a newer version: 4.0.66

/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package javax.enterprise.inject;

import java.lang.annotation.Annotation;
import javax.inject.Provider;
import javax.enterprise.util.TypeLiteral;

/**
 * Factory to create instances of a bean.
 *
 * Example: injecting and using Instance
 *
 *  * package example;
 *
 * import javax.enterprise.inject.*;
 * import javax.servlet.*;
 *
 * public class MyServlet extends GenericServlet {
 *  {@link javax.enterprise.inject.Obtains @Obtains} {@literal @Instance}<MyBean> _beanFactory;
 *
 *  public void service(ServletRequest req, ServletResponse res)
 *  {
 *    MyBean bean = _beanFactory.get();
 *  }
 * }
 * 
 *
 * @see javax.event.Event
 */
public interface Instance extends Provider, Iterable
{
  /**
   * Restricts the instance given a set of qualifiers
   */
  public Instance select(Annotation ... qualifiers);

  /**
   * Restricts the instance to a subtype and bindings.
   */
  public  Instance select(Class subtype,
                                          Annotation... qualifiers);

  /**
   * Restricts the instance to a subtype and bindings.
   */
  public  Instance select(TypeLiteral subtype,
                                          Annotation... qualifiers);

  /**
   * Test if there are any beans that match the instance.
   */
  public boolean isUnsatisfied();

  /**
   * Test if there are multiple beans that match the instance.
   */
  public boolean isAmbiguous();
}