hk2 4.0.1 · org.glassfish.hk2.api.ActiveDescriptor · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public T	Returns: An instance of this ActiveDescriptor create(ServiceHandle<?> The root service handle, which can be used to associated all the PerLookup objects with this creation root) Creates an instance of the ActiveDescriptor.
public void	dispose(T The instance to destroy instance) Disposes this instance.
public Set<Type>	Returns: the set of types this ActiveDescriptor must implement or extend getContractTypes() The set of types that this ActiveDescriptor must produce.
public Long	Returns: The locator ID of the associated factory service getFactoryLocatorId() If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then this field will return the ServiceId of its associated Factory service.
public Long	Returns: The service ID of the associated factory service getFactoryServiceId() If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then this field will return the ServiceId of its associated Factory service.
public Class<?>	Returns: The class that directly implements the contract types, or the class that is the factory for an object that implements the contract types getImplementationClass() The implementation class that should be used to generate new instances of this descriptor.
public Type	Returns: The type of the implementation or the implementation class getImplementationType() If known the Type of the implementation.
public List<Injectee>	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 getInjectees() Returns the full list of Injectees this class has.
public Set<Annotation>	Returns: The set of annotations that this ActiveDescriptor provides getQualifierAnnotations() The full set of qualifiers that this ActiveDescriptor provides
public Class<? extends Annotation>	Returns: The scope of this ActiveDescriptor getScopeAnnotation() Returns the scope that this ActiveDescriptor belongs to
public Annotation	Returns: The scope of this ActiveDescriptor as an `Annotation` getScopeAsAnnotation() Returns the scope as an `Annotation` implementation that this ActiveDescriptor belongs to
public boolean	Returns: true if this descriptor has been reified, false otherwise isReified() This method returns true if this descriptor has been reified (class loaded).

Method Detail

create	back to summary
public T create(ServiceHandle<?> root) 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:ServiceHandle<?> The root service handle, which can be used to associated all the PerLookup objects with this creation Returns:T An instance of this ActiveDescriptor

create

back to summary

public T create(ServiceHandle<?> root)

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:ServiceHandle<?>: The root service handle, which can be used to associated all the PerLookup objects with this creation

Returns:T

An instance of this ActiveDescriptor

dispose	back to summary
public void dispose(T instance) Disposes this instance. All the PerLookup objects that were created for this instance will be destroyed after this object has been destroyed Parameters instance:T The instance to destroy

dispose

back to summary

public void dispose(T instance)

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

Parameters

instance:T: The instance to destroy

getContractTypes	back to summary
public Set<Type> getContractTypes() The set of types that this ActiveDescriptor must produce. These types may be Classes or ParameterizedTypes, and may be no other subclass of Type Returns:Set<Type> the set of types this ActiveDescriptor must implement or extend

getContractTypes

back to summary

public Set<Type> getContractTypes()

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

Returns:Set<Type>: the set of types this ActiveDescriptor must implement or extend

getFactoryLocatorId	back to summary
public Long getFactoryLocatorId() 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 Returns:Long The locator ID of the associated factory service

getFactoryLocatorId

back to summary

public Long getFactoryLocatorId()

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

Returns:Long: The locator ID of the associated factory service

getFactoryServiceId	back to summary
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 Returns:Long The service ID of the associated factory service

getFactoryServiceId

back to summary

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

Returns:Long: The service ID of the associated factory service

getImplementationClass	back to summary
public Class<?> getImplementationClass() 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:Class<?> The class that directly implements the contract types, or the class that is the factory for an object that implements the contract types

getImplementationClass

back to summary

public Class<?> getImplementationClass()

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:Class<?>: The class that directly implements the contract types, or the class that is the factory for an object that implements the contract types

getImplementationType back to summary

getImplementationType	back to summary
public Type getImplementationType() If known the Type of the implementation. If unknown will return the same as `getImplementationClass()` Returns:Type The type of the implementation or the implementation class

public Type getImplementationType()

If known the Type of the implementation. If unknown will return the same as getImplementationClass()

Returns:Type: The type of the implementation or the implementation class

getInjectees	back to summary
public List<Injectee> getInjectees() 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 Returns:List<Injectee> Will not return null, but may return an empty list. The set of Injectees that must be resolved before this ActiveDescriptor can be constructed

getInjectees

back to summary

public List<Injectee> getInjectees()

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

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

getQualifierAnnotations	back to summary
public Set<Annotation> getQualifierAnnotations() The full set of qualifiers that this ActiveDescriptor provides Returns:Set<Annotation> The set of annotations that this ActiveDescriptor provides

getQualifierAnnotations

back to summary

public Set<Annotation> getQualifierAnnotations()

The full set of qualifiers that this ActiveDescriptor provides

Returns:Set<Annotation>: The set of annotations that this ActiveDescriptor provides

getScopeAnnotation	back to summary
public Class<? extends Annotation> getScopeAnnotation() Returns the scope that this ActiveDescriptor belongs to Returns:Class<? extends Annotation> The scope of this ActiveDescriptor

getScopeAnnotation

back to summary

public Class<? extends Annotation> getScopeAnnotation()

Returns the scope that this ActiveDescriptor belongs to

Returns:Class<? extends Annotation>: The scope of this ActiveDescriptor

getScopeAsAnnotation back to summary

getScopeAsAnnotation	back to summary
public Annotation getScopeAsAnnotation() Returns the scope as an `Annotation` implementation that this ActiveDescriptor belongs to Returns:Annotation The scope of this ActiveDescriptor as an `Annotation`

public Annotation getScopeAsAnnotation()

Returns the scope as an Annotation implementation that this ActiveDescriptor belongs to

Returns:Annotation: The scope of this ActiveDescriptor as an Annotation

isReified	back to summary
public boolean isReified() 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 Returns:boolean true if this descriptor has been reified, false otherwise

isReified

back to summary

public boolean isReified()

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

Returns:boolean: true if this descriptor has been reified, false otherwise

public Interface ActiveDescriptor<T>

Method Summary

Method Detail