org.glassfish.hk2.utilities

Class AliasDescriptor<T>

java.lang.Object

org.glassfish.hk2.utilities.DescriptorImpl

org.glassfish.hk2.utilities.AbstractActiveDescriptor<T>

org.glassfish.hk2.utilities.AliasDescriptor<T>

All Implemented Interfaces:

java.io.Serializable, ActiveDescriptor<T>, Descriptor, SingleCache<T>

public class AliasDescriptor<T>
extends AbstractActiveDescriptor<T>

A descriptor class that serves as an alias for another descriptor.

Author:

tbeerbower

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AliasDescriptor(ServiceLocator locator, ActiveDescriptor<T> descriptor, java.lang.String contract, java.lang.String name) Construct an AliasDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
T	create(ServiceHandle<?> root) Creates an instance of the ActiveDescriptor.
void	dispose(T instance) Disposes this instance.
java.util.Set<java.lang.reflect.Type>	getContractTypes() The set of types that this ActiveDescriptor must produce.
ActiveDescriptor<T>	getDescriptor() Get the descriptor being aliased.
java.lang.String	getImplementation() Returns the fully qualified class name of the implementation class.
java.lang.Class<?>	getImplementationClass() The implementation class that should be used to generate new instances of this descriptor.
java.util.List<Injectee>	getInjectees() Returns the full list of Injectees this class has.
java.util.Set<java.lang.annotation.Annotation>	getQualifierAnnotations() The full set of qualifiers that this ActiveDescriptor provides
java.lang.Class<? extends java.lang.annotation.Annotation>	getScopeAnnotation() Returns the scope that this ActiveDescriptor belongs to
boolean	isReified() This method returns true if this descriptor has been reified (class loaded).

Methods inherited from class org.glassfish.hk2.utilities.AbstractActiveDescriptor

addContractType, addQualifierAnnotation, getCache, getFactoryLocatorId, getFactoryServiceId, isCacheSet, releaseCache, removeContractType, removeQualifierAnnotation, setCache, setFactoryId, setName, setReified

Methods inherited from class org.glassfish.hk2.utilities.DescriptorImpl

addAdvertisedContract, addMetadata, addMetadata, addQualifier, clearMetadata, equals, getAdvertisedContracts, getClassAnalysisName, getDescriptorType, getDescriptorVisibility, getLoader, getLocatorId, getMetadata, getName, getQualifiers, getRanking, getScope, getServiceId, hashCode, isProxiable, pretty, readObject, removeAdvertisedContract, removeAllMetadata, removeMetadata, removeQualifier, setClassAnalysisName, setDescriptorType, setDescriptorVisibility, setImplementation, setLoader, setLocatorId, setMetadata, setProxiable, setRanking, setScope, setServiceId, toString, writeObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.glassfish.hk2.api.Descriptor

getAdvertisedContracts, getClassAnalysisName, getDescriptorType, getDescriptorVisibility, getLoader, getLocatorId, getMetadata, getName, getQualifiers, getRanking, getScope, getServiceId, isProxiable, setRanking

Constructor Detail

AliasDescriptor

public AliasDescriptor(ServiceLocator locator,
               ActiveDescriptor<T> descriptor,
               java.lang.String contract,
               java.lang.String name)

Construct an AliasDescriptor.

Parameters:

locator - the service locator

descriptor - the descriptor to be aliased

contract - the contact

name - the name

Method Detail

getImplementationClass

public java.lang.Class<?> getImplementationClass()

Description copied from interface: ActiveDescriptor

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

Returns:

The class that directly implements the contract types, or the class that is the factory for an object that implements the contract types

create

public T create(ServiceHandle<?> root)

Description copied from interface: ActiveDescriptor

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

Parameters:

root - The root service handle, which can be used to associated all the PerLookup objects with this creation

Returns:

An instance of this ActiveDescriptor

isReified

public boolean isReified()

Description copied from interface: ActiveDescriptor

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

Specified by:

isReified in interface ActiveDescriptor<T>

Overrides:

isReified in class AbstractActiveDescriptor<T>

Returns:

true if this descriptor has been reified, false otherwise

getImplementation

public java.lang.String getImplementation()

Description copied from interface: Descriptor

Returns the fully qualified class name of the implementation class. If this is a factory descriptor then this will return the fully qualified name of the class implementing the factory interface.

Specified by:

getImplementation in interface Descriptor

Overrides:

getImplementation in class DescriptorImpl

Returns:

Might return null in some cases, but will usually return the fully qualified class name of the implementation class or of the factory class for this descriptor

getContractTypes

public java.util.Set<java.lang.reflect.Type> getContractTypes()

Description copied from interface: ActiveDescriptor

The set of types that this ActiveDescriptor must produce. These types may be Classes or ParameterizedTypes, and may be no other subclass of Type

Specified by:

getContractTypes in interface ActiveDescriptor<T>

Overrides:

getContractTypes in class AbstractActiveDescriptor<T>

Returns:

the set of types this ActiveDescriptor must implement or extend

getScopeAnnotation

public java.lang.Class<? extends java.lang.annotation.Annotation> getScopeAnnotation()

Description copied from interface: ActiveDescriptor

Returns the scope that this ActiveDescriptor belongs to

Specified by:

getScopeAnnotation in interface ActiveDescriptor<T>

Overrides:

getScopeAnnotation in class AbstractActiveDescriptor<T>

Returns:

The scope of this ActiveDescriptor

getQualifierAnnotations

public java.util.Set<java.lang.annotation.Annotation> getQualifierAnnotations()

Description copied from interface: ActiveDescriptor

The full set of qualifiers that this ActiveDescriptor provides

Specified by:

getQualifierAnnotations in interface ActiveDescriptor<T>

Overrides:

getQualifierAnnotations in class AbstractActiveDescriptor<T>

Returns:

The set of annotations that this ActiveDescriptor provides

getInjectees

public java.util.List<Injectee> getInjectees()

Description copied from interface: ActiveDescriptor

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

Specified by:

getInjectees in interface ActiveDescriptor<T>

Overrides:

getInjectees in class AbstractActiveDescriptor<T>

Returns:

Will not return null, but may return an empty list. The set of Injectees that must be resolved before this ActiveDescriptor can be constructed

dispose

public void dispose(T instance)

Description copied from interface: ActiveDescriptor

Disposes this instance. All the PerLookup objects that were created for this instance will be destroyed after this object has been destroyed

Specified by:

dispose in interface ActiveDescriptor<T>

Overrides:

dispose in class AbstractActiveDescriptor<T>

Parameters:

instance - The instance to destroy

getDescriptor

public ActiveDescriptor<T> getDescriptor()

Get the descriptor being aliased.

Returns:

the descriptor