All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.hk2.api.ActiveDescriptor Maven / Gradle / Ivy

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012-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 compliance 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.glassfish.hk2.api;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Set;

/**
 * An ActiveDescriptor contains information about a Descriptor after it has been reified.
 * Most of the methods in an ActiveDescriptor cannot be called until the isReified method
 * return true.  Prior to that the information is not yet known.  ActiveDescriptors
 * can be reified with the {@link ServiceLocator}.reifyDescriptor method.
 * 

* ActiveDescriptors may also be provided to the system pre-reified, which is useful * when the Service described may be produced by a third-party system. In this case * the ActiveDescriptors create method must use the third-party system in order to * create instances of the described service * * @author jwells * * @param This is the type produced by the cache and consumed by the cache */ public interface ActiveDescriptor extends Descriptor, SingleCache { /** * This method returns true if this descriptor has been reified * (class loaded). If this method returns false then the other methods * in this interface will throw an IllegalStateException. Once this * method returns true it may be * * @return true if this descriptor has been reified, false otherwise */ public boolean isReified(); /** * The implementation class that should be used * to generate new instances of this descriptor. *

* If the class returned is a Factory, then the * factory is used to create instances. In this case * the system will get an instance of the factory and * use it to create the instances * * @return The class that directly implements the contract * types, or the class that is the factory for an object * that implements the contract types */ public Class getImplementationClass(); /** * The set of types that this ActiveDescriptor must produce. * These types may be Classes or ParameterizedTypes, and * may be no other subclass of Type * * @return the set of types this ActiveDescriptor must implement * or extend */ public Set getContractTypes(); /** * Returns the scope as an {@link Annotation} * implementation that this ActiveDescriptor belongs to * * @return The scope of this ActiveDescriptor as an {@link Annotation} */ public Annotation getScopeAsAnnotation(); /** * Returns the scope that this ActiveDescriptor belongs to * * @return The scope of this ActiveDescriptor */ public Class getScopeAnnotation(); /** * The full set of qualifiers that this ActiveDescriptor * provides * * @return The set of annotations that this ActiveDescriptor * provides */ public Set getQualifierAnnotations(); /** * Returns the full list of Injectees this class has. These * references will be resolved prior to the class being constructed, * even if these injectees are field or method injectees. *

* If this descriptor is describing a factory created type then * this list must have zero length * * @return Will not return null, but may return an empty list. The set * of Injectees that must be resolved before this ActiveDescriptor can * be constructed */ public List getInjectees(); /** * If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then * this field will return the ServiceId of its associated Factory * service. Otherwise this method should return null * * @return The service ID of the associated factory service */ public Long getFactoryServiceId(); /** * If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then * this field will return the ServiceId of its associated Factory * service. Otherwise this method should return null * * @return The locator ID of the associated factory service */ public Long getFactoryLocatorId(); /** * Creates an instance of the ActiveDescriptor. All of the * Injectee's must be created prior to instantiation, and * associated with the ExtendedProvider so that they can be * destroyed properly * * @param root The root service handle, which can be used * to associated all the PerLookup objects with this creation * * @return An instance of this ActiveDescriptor */ public T create(ServiceHandle root); /** * Disposes this instance. All the PerLookup objects that * were created for this instance will be destroyed after this * object has been destroyed * * @param instance The instance to destroy */ public void dispose(T instance); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy