org.testifyproject.glassfish.hk2.api.InstantiationService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-docker-client Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 Oracle and/or its affiliates. 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 org.testifyproject.testifyprojectpliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.testifyproject.glassfish.hk2.api;

import org.testifyproject.jvnet.hk2.annotations.Contract;

/**
 * This service is used to get information about
 * the creation of a service from an
 * implementation of {@link Factory}.  The
 * system creates this service, and while
 * it can be injected into any service or
 * even looked up, it only has data
 * when called from inside the {@link Factory#provide()}
 * method of a {@link Factory}.
 * 
 * @author jwells
 *
 */
@Contract
public interface InstantiationService {
    /**
     * This method may be called from inside the
     * implementation of {@link Factory#provide()}
     * method to get more information about the
     * reason for instantiation.  If this method
     * is called outside the scope of a
     * {@link Factory#provide()} method the results
     * are indeterminate
     * 
     * @return A non-null InstantiationData object
     * containing information about the caller of
     * the {@link Factory#provide()} method. May
     * return null if no information is known or
     * if called from outside of a {@link Factory#provide()}
     * method
     */
    public InstantiationData getInstantiationData();
}