AliasDescriptor (HK2 API module 2.6.1 API)

java.lang.Object
- org.glassfish.hk2.utilities.DescriptorImpl
- - org.glassfish.hk2.utilities.AbstractActiveDescriptor<T>
  - - org.glassfish.hk2.utilities.AliasDescriptor<T>

Type Parameters:

T - The cache type

All Implemented Interfaces:

Externalizable, Serializable, ActiveDescriptor<T>, Descriptor, SingleCache<T>
```
public class AliasDescriptor<T>
extends AbstractActiveDescriptor<T>
```
An active descriptor class that serves as an alias for another descriptor. This alias can have only one contract that may or may not also be advertised by the host descriptor. An AliasDescriptor can have a different name from the host descriptor as well

Author:

tbeerbower

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALIAS_FREE_DESCRIPTOR` This is the value the metadata field ALIAS_METADATA_MARKER will take if the descriptor being aliased does not have a locator id or a service id
`static String`	`ALIAS_METADATA_MARKER` This will be put in all Alias descriptors.

Constructor Summary

Constructors
Constructor and Description
`AliasDescriptor()` For serialization
`AliasDescriptor(ServiceLocator locator, ActiveDescriptor<T> descriptor, String contract, String name)` Construct an AliasDescriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`create(ServiceHandle<?> root)` Creates an instance of the ActiveDescriptor.
`void`	`dispose(T instance)` Disposes this instance.
`boolean`	`equals(Object o)` This equals matches only if the following fields of the descriptor match: implementation contracts name scope qualifiers descriptorType descriptorVisibility metadata proxiable proxyForSameScope analysisName
`Set<Type>`	`getContractTypes()` The set of types that this ActiveDescriptor must produce.
`ActiveDescriptor<T>`	`getDescriptor()` Get the descriptor being aliased.
`String`	`getImplementation()` Returns the fully qualified class name of the implementation class.
`Class<?>`	`getImplementationClass()` The implementation class that should be used to generate new instances of this descriptor.
`Type`	`getImplementationType()` If known the Type of the implementation.
`List<Injectee>`	`getInjectees()` Returns the full list of Injectees this class has.
`Set<Annotation>`	`getQualifierAnnotations()` The full set of qualifiers that this ActiveDescriptor provides
`Set<String>`	`getQualifiers()` Returns all of the annotation classes that this object should be registered with or looked up by
`Class<? extends Annotation>`	`getScopeAnnotation()` Returns the scope that this ActiveDescriptor belongs to
`int`	`hashCode()`
`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, getScopeAsAnnotation, isCacheSet, releaseCache, removeContractType, removeQualifierAnnotation, setCache, setFactoryId, setImplementationType, setName, setReified, setScopeAnnotation, setScopeAsAnnotation

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, getRanking, getScope, getServiceId, isProxiable, isProxyForSameScope, setRanking

- Field Detail
  - ALIAS_METADATA_MARKER
```
public static final String ALIAS_METADATA_MARKER
```
    This will be put in all Alias descriptors. The value will be ALIAS_FREE_DESCRIPTOR if the descritpor being aliased does not have a locator and service id. If the descriptor being aliased does have a locator and service id the value will be .
    
    See Also:
    
    Constant Field Values
  - ALIAS_FREE_DESCRIPTOR
```
public static final String ALIAS_FREE_DESCRIPTOR
```
    This is the value the metadata field ALIAS_METADATA_MARKER will take if the descriptor being aliased does not have a locator id or a service id
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AliasDescriptor
```
public AliasDescriptor()
```
    For serialization
  - AliasDescriptor
```
public AliasDescriptor(ServiceLocator locator,
                       ActiveDescriptor<T> descriptor,
                       String contract,
                       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 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
  - getImplementationType
```
public Type getImplementationType()
```
    Description copied from interface: ActiveDescriptor
    
    If known the Type of the implementation. If unknown will return the same as ActiveDescriptor.getImplementationClass()
    
    Returns:
    
    The type of the implementation or the implementation class
  - 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 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 Set<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 Class<? extends 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 Set<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
  - getQualifiers
```
public Set<String> getQualifiers()
```
    Description copied from interface: Descriptor
    
    Returns all of the annotation classes that this object should be registered with or looked up by
    
    Specified by:
    
    getQualifiers in interface Descriptor
    
    Overrides:
    
    getQualifiers in class DescriptorImpl
    
    Returns:
    
    Never returns null, but may return an empty set. The set of fully qualified class names that are annotations that this object must have
  - getInjectees
```
public 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractActiveDescriptor<T>
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: DescriptorImpl
    This equals matches only if the following fields of the descriptor match:
    - implementation
    - contracts
    - name
    - scope
    - qualifiers
    - descriptorType
    - descriptorVisibility
    - metadata
    - proxiable
    - proxyForSameScope
    - analysisName
    Overrides:
    
    equals in class AbstractActiveDescriptor<T>
    
    Parameters:
    
    o - The object to compare to this one. May be null (which will result in a false)
    
    Returns:
    
    true if the descriptors are equal

Class AliasDescriptor<T>

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_METADATA_MARKER

ALIAS_FREE_DESCRIPTOR

Constructor Detail

AliasDescriptor

AliasDescriptor

Method Detail

getImplementationClass

getImplementationType

create

isReified

getImplementation

getContractTypes

getScopeAnnotation

getQualifierAnnotations

getQualifiers

getInjectees

dispose

getDescriptor

hashCode

equals