org.jvnet.hk2.component.InhabitantProviderInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of auto-depends Show documentation
${project.name}
The newest version!
/*
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2007-2011 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.jvnet.hk2.component;

import java.util.Iterator;
import java.util.Set;

import org.jvnet.hk2.annotations.Contract;

import com.sun.hk2.component.AbstractInhabitantImpl;
import com.sun.hk2.component.InhabitantStore;

/**
 * A hook for providers to implement in order to extend or redefine
 * the inhabitant Hk2 will incorporate into the {@link Habitat}.
 * 
 * @author Jeff Trent
 */
@Contract
public interface InhabitantProviderInterceptor {

  /**
   * Called by the framework to either decorate the inhabitant,
   * or even intercept and replace the created inhabitant.
   * 
   * @param inhabitant
   *    the inhabitant offered by the framework, or the previous interceptor
   * @param typeName
   *    the type name of the inhabitant
   * @param indicies
   *    the indicies of the inhabitant
   * @param remainingInterceptors
   *    the interceptors that follow.  It is the responsibility
   *    of the implementation to continue the visitations for remaining
   *    interceptors unless there is some special conditions warranting
   *    an immediate short-circuiting.
   * @param store
   *    the store that can be used for adding additional inhabitants
   *    
   * @return the Inhabitant for the framework to add, or null if none should be added
   */
  AbstractInhabitantImpl visit(AbstractInhabitantImpl inhabitant, 
      String typeName,
      Set indicies,
      Iterator remainingInterceptors,
      InhabitantStore store);
  
}