hk2 4.0.1 · org.jvnet.hk2.internal.SystemDescriptor · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final ActiveDescriptor<T>	activeDescriptor
private final Descriptor	baseDescriptor
private T	cachedValue
private final ReentrantLock	cacheLock
private boolean	cacheSet
private volatile boolean	closed
private Set<Type>	contracts
private Creator<T>	creator
private Long	factoryLocatorId
private Long	factoryServiceId
private final Long	id
private Class<?>	implClass
private Type	implType
private final List<InstanceLifecycleListener>	instanceListeners
private final ReentrantLock	lock
private final Set<IndexedListData>	myLists
private final Condition	notReifyingCondition
private boolean	preAnalyzed
private Set<Annotation>	qualifiers
private volatile boolean	reified
private boolean	reifying
private Class<? extends Annotation>	scope
private Annotation	scopeAnnotation
private final ServiceLocatorImpl	sdLocator
private int	singletonGeneration
private final HashMap<ValidationService, Boolean>	validationServiceCache

Access	Constructor and Description
pack-priv	SystemDescriptor(Descriptor baseDescriptor, boolean requiresDeepCopy, ServiceLocatorImpl locator, Long serviceId)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addList(IndexedListData indexedList)
private void	checkState()
public boolean	close() Implements org.jvnet.hk2.internal.Closeable.close. Idempotent close method.
public T	create(ServiceHandle<?> root) Implements org.glassfish.hk2.api.ActiveDescriptor.create. Creates an instance of the ActiveDescriptor.
public void	dispose(T instance) Implements org.glassfish.hk2.api.ActiveDescriptor.dispose. Disposes this instance.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Set<String>	getAdvertisedContracts() Implements org.glassfish.hk2.api.Descriptor.getAdvertisedContracts. Returns the base class name of the contracts that this service describes.
public T	getCache() Implements org.glassfish.hk2.api.SingleCache.getCache. This can be used for scopes that will only every be created once.
public String	getClassAnalysisName() Implements org.glassfish.hk2.api.Descriptor.getClassAnalysisName. Returns the name of the `ClassAnalyzer` service that should be used to discover the constructors, initialization methods, field and postConstruct and preDestory methods.
public Set<Type>	getContractTypes() Implements org.glassfish.hk2.api.ActiveDescriptor.getContractTypes. The set of types that this ActiveDescriptor must produce.
public DescriptorType	getDescriptorType() Implements org.glassfish.hk2.api.Descriptor.getDescriptorType. Returns CLASS if this is a class descriptor and FACTORY if this is a descriptor describing a factory for a type, in which case the implClass should point to the implementation class of the factory
public DescriptorVisibility	getDescriptorVisibility() Implements org.glassfish.hk2.api.Descriptor.getDescriptorVisibility. Returns the visibility of this descriptor.
private ActiveDescriptor<?>	getFactoryDescriptor(Method provideMethod, Type factoryProvidedType, ServiceLocatorImpl locator, Collector collector)
public Long	getFactoryLocatorId() Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryLocatorId. If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then this field will return the ServiceId of its associated Factory service.
public Long	getFactoryServiceId() Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryServiceId. If this ActiveDescriptor has DescriptorType of PROVIDE_METHOD then this field will return the ServiceId of its associated Factory service.
public String	getImplementation() Implements org.glassfish.hk2.api.Descriptor.getImplementation. Returns the fully qualified class name of the implementation class.
public Class<?>	getImplementationClass() Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationClass. The implementation class that should be used to generate new instances of this descriptor.
public Type	getImplementationType() Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationType. If known the Type of the implementation.
public List<Injectee>	getInjectees() Implements org.glassfish.hk2.api.ActiveDescriptor.getInjectees. Returns the full list of Injectees this class has.
public HK2Loader	getLoader() Implements org.glassfish.hk2.api.Descriptor.getLoader. This returns the loader that should be used when classloading this descriptor.
public Long	getLocatorId() Implements org.glassfish.hk2.api.Descriptor.getLocatorId. This returns the id of the ServiceLocator which this descriptor is registered with.
public Map<String, List<String>>	getMetadata() Implements org.glassfish.hk2.api.Descriptor.getMetadata. Returns all of the metadata associated that this object should be registered with or looked up by
public String	getName() Implements org.glassfish.hk2.api.Descriptor.getName. The name of this descriptor.
pack-priv Class<?>	getPreAnalyzedClass()
public Set<Annotation>	getQualifierAnnotations() Implements org.glassfish.hk2.api.ActiveDescriptor.getQualifierAnnotations. The full set of qualifiers that this ActiveDescriptor provides
public Set<String>	getQualifiers() Implements org.glassfish.hk2.api.Descriptor.getQualifiers. Returns all of the annotation classes that this object should be registered with or looked up by
public int	getRanking() Implements org.glassfish.hk2.api.Descriptor.getRanking. Returns the ranking of this descriptor.
public String	getScope() Implements org.glassfish.hk2.api.Descriptor.getScope. Returns the fully qualified class name of the scope annotation that should be associated with this descriptor.
public Class<? extends Annotation>	getScopeAnnotation() Implements org.glassfish.hk2.api.ActiveDescriptor.getScopeAnnotation. Returns the scope that this ActiveDescriptor belongs to
public Annotation	getScopeAsAnnotation() Implements org.glassfish.hk2.api.ActiveDescriptor.getScopeAsAnnotation. Returns the scope as an `Annotation` implementation that this ActiveDescriptor belongs to
public Long	getServiceId() Implements org.glassfish.hk2.api.Descriptor.getServiceId. This returns the unique identifier for this descriptor.
pack-priv int	getSingletonGeneration()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	internalReify(Class<?> The impl class to reify implClass, Collector An error collector for errors collector) The service locator must hold its lock for this cal
pack-priv void	invokeInstanceListeners(InstanceLifecycleEvent event)
public boolean	isCacheSet() Implements org.glassfish.hk2.api.SingleCache.isCacheSet. Returns true if this cache has been set
public boolean	isClosed() Implements org.jvnet.hk2.internal.Closeable.isClosed. Returns true if the instance has been closed
public Boolean	isProxiable() Implements org.glassfish.hk2.api.Descriptor.isProxiable. If this returns true then the system will create a proxy for instances of this descriptor.
public Boolean	isProxyForSameScope() Implements org.glassfish.hk2.api.Descriptor.isProxyForSameScope. This value determines whether or not this service should be proxied when being injected into other services of the same scope.
public boolean	isReified() Implements org.glassfish.hk2.api.ActiveDescriptor.isReified. This method returns true if this descriptor has been reified (class loaded).
pack-priv boolean	Returns: true if this validation service should validate this descriptor isValidating(ValidationService The service to get the isValidating decision from service) Gets the decision of the filter from this service.
pack-priv void	reify(Class<?> implClass, Collector collector)
public void	releaseCache() Implements org.glassfish.hk2.api.SingleCache.releaseCache. Removes the cached value and makes it such that this cache has not been set
pack-priv void	removeList(IndexedListData indexedList)
pack-priv void	reupInstanceListeners(List<InstanceLifecycleListener> listeners)
public void	setCache(T cacheMe) Implements org.glassfish.hk2.api.SingleCache.setCache. Sets the value into the cache
pack-priv void	setFactoryIds(Long factoryLocatorId, Long factoryServiceId)
public int	setRanking(int ranking) Implements org.glassfish.hk2.api.Descriptor.setRanking. Returns the ranking of this descriptor.
pack-priv int	setRankWithLock(int ranking)
pack-priv void	setSingletonGeneration(int gen)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

activeDescriptor	back to summary
private final ActiveDescriptor<T> activeDescriptor

baseDescriptor	back to summary
private final Descriptor baseDescriptor

cachedValue	back to summary
private T cachedValue

cacheLock	back to summary
private final ReentrantLock cacheLock

cacheSet	back to summary
private boolean cacheSet

closed	back to summary
private volatile boolean closed

contracts	back to summary
private Set<Type> contracts

creator	back to summary
private Creator<T> creator

factoryLocatorId	back to summary
private Long factoryLocatorId

factoryServiceId	back to summary
private Long factoryServiceId

id	back to summary
private final Long id

implClass	back to summary
private Class<?> implClass

implType	back to summary
private Type implType

instanceListeners	back to summary
private final List<InstanceLifecycleListener> instanceListeners

lock	back to summary
private final ReentrantLock lock

myLists	back to summary
private final Set<IndexedListData> myLists

notReifyingCondition	back to summary
private final Condition notReifyingCondition

preAnalyzed	back to summary
private boolean preAnalyzed

qualifiers	back to summary
private Set<Annotation> qualifiers

reified	back to summary
private volatile boolean reified

reifying	back to summary
private boolean reifying

scope	back to summary
private Class<? extends Annotation> scope

scopeAnnotation	back to summary
private Annotation scopeAnnotation

sdLocator	back to summary
private final ServiceLocatorImpl sdLocator

singletonGeneration	back to summary
private int singletonGeneration

validationServiceCache	back to summary
private final HashMap<ValidationService, Boolean> validationServiceCache

SystemDescriptor	back to summary
pack-priv SystemDescriptor(Descriptor baseDescriptor, boolean requiresDeepCopy, ServiceLocatorImpl locator, Long serviceId) Annotations @SuppressWarnings:unchecked

Method Detail

addList	back to summary
pack-priv void addList(IndexedListData indexedList)

checkState	back to summary
private void checkState()

close	back to summary
public boolean close() Implements org.jvnet.hk2.internal.Closeable.close. Doc from org.jvnet.hk2.internal.Closeable.close. Idempotent close method. Returns true if the instance had already been closed Annotations @Override

back to summary

public boolean close()

Implements org.jvnet.hk2.internal.Closeable.close.

Doc from org.jvnet.hk2.internal.Closeable.close.

Idempotent close method. Returns true if the instance had already been closed

Annotations

@Override

create	back to summary
public T create(ServiceHandle<?> root) Implements org.glassfish.hk2.api.ActiveDescriptor.create. Doc from org.glassfish.hk2.api.ActiveDescriptor.create. 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 Annotations @Override

create

back to summary

public T create(ServiceHandle<?> root)

Implements org.glassfish.hk2.api.ActiveDescriptor.create.

Doc from org.glassfish.hk2.api.ActiveDescriptor.create.

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

Annotations

@Override

dispose	back to summary
public void dispose(T instance) Implements org.glassfish.hk2.api.ActiveDescriptor.dispose. Doc from org.glassfish.hk2.api.ActiveDescriptor.dispose. Disposes this instance. All the PerLookup objects that were created for this instance will be destroyed after this object has been destroyed Annotations @Override

dispose

back to summary

public void dispose(T instance)

Implements org.glassfish.hk2.api.ActiveDescriptor.dispose.

Doc from org.glassfish.hk2.api.ActiveDescriptor.dispose.

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

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @SuppressWarnings:rawtypes @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@SuppressWarnings:rawtypes
@Override

getAdvertisedContracts	back to summary
public Set<String> getAdvertisedContracts() Implements org.glassfish.hk2.api.Descriptor.getAdvertisedContracts. Doc from org.glassfish.hk2.api.Descriptor.getAdvertisedContracts. Returns the base class name of the contracts that this service describes. If the contract is a paramterized type this will return the raw class. If this service can be looked up by its implementation class then the name of the implementation class must also be found in this list Annotations @Override

getAdvertisedContracts

back to summary

public Set<String> getAdvertisedContracts()

Implements org.glassfish.hk2.api.Descriptor.getAdvertisedContracts.

Doc from org.glassfish.hk2.api.Descriptor.getAdvertisedContracts.

Returns the base class name of the contracts that this service describes. If the contract is a paramterized type this will return the raw class. If this service can be looked up by its implementation class then the name of the implementation class must also be found in this list

Annotations

@Override

getCache	back to summary
public T getCache() Implements org.glassfish.hk2.api.SingleCache.getCache. Doc from org.glassfish.hk2.api.SingleCache.getCache. This can be used for scopes that will only every be created once. The returned value must have been set previously with setCache. If this is called when isCacheSet is false will result in a RuntimeException Annotations @Override

getCache

back to summary

public T getCache()

Implements org.glassfish.hk2.api.SingleCache.getCache.

Doc from org.glassfish.hk2.api.SingleCache.getCache.

This can be used for scopes that will only every be created once. The returned value must have been set previously with setCache. If this is called when isCacheSet is false will result in a RuntimeException

Annotations

@Override

getClassAnalysisName back to summary

getClassAnalysisName	back to summary
public String getClassAnalysisName() Implements org.glassfish.hk2.api.Descriptor.getClassAnalysisName. Doc from org.glassfish.hk2.api.Descriptor.getClassAnalysisName. Returns the name of the `ClassAnalyzer` service that should be used to discover the constructors, initialization methods, field and postConstruct and preDestory methods. If null the default implementation will be used. Will be ignored for descriptors that are not automatically analyzed by hk2 Annotations @Override

public String getClassAnalysisName()

Implements org.glassfish.hk2.api.Descriptor.getClassAnalysisName.

Doc from org.glassfish.hk2.api.Descriptor.getClassAnalysisName.

Returns the name of the ClassAnalyzer service that should be used to discover the constructors, initialization methods, field and postConstruct and preDestory methods. If null the default implementation will be used. Will be ignored for descriptors that are not automatically analyzed by hk2

Annotations

@Override

getContractTypes	back to summary
public Set<Type> getContractTypes() Implements org.glassfish.hk2.api.ActiveDescriptor.getContractTypes. Doc from org.glassfish.hk2.api.ActiveDescriptor.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 Annotations @Override

getContractTypes

back to summary

public Set<Type> getContractTypes()

Implements org.glassfish.hk2.api.ActiveDescriptor.getContractTypes.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

getDescriptorType	back to summary
public DescriptorType getDescriptorType() Implements org.glassfish.hk2.api.Descriptor.getDescriptorType. Doc from org.glassfish.hk2.api.Descriptor.getDescriptorType. Returns CLASS if this is a class descriptor and FACTORY if this is a descriptor describing a factory for a type, in which case the implClass should point to the implementation class of the factory Annotations @Override

getDescriptorType

back to summary

public DescriptorType getDescriptorType()

Implements org.glassfish.hk2.api.Descriptor.getDescriptorType.

Doc from org.glassfish.hk2.api.Descriptor.getDescriptorType.

Returns CLASS if this is a class descriptor and FACTORY if this is a descriptor describing a factory for a type, in which case the implClass should point to the implementation class of the factory

Annotations

@Override

getDescriptorVisibility	back to summary
public DescriptorVisibility getDescriptorVisibility() Implements org.glassfish.hk2.api.Descriptor.getDescriptorVisibility. Doc from org.glassfish.hk2.api.Descriptor.getDescriptorVisibility. Returns the visibility of this descriptor. If the visibility is NORMAL then this descriptor may be seen by all children locators of the locator in which this descriptor is bound If the visibility is LOCAL then this descriptor may only be seen by the servcie locator in which it is bound, and in none of the children of that locator Annotations @Override

getDescriptorVisibility

back to summary

public DescriptorVisibility getDescriptorVisibility()

Implements org.glassfish.hk2.api.Descriptor.getDescriptorVisibility.

Doc from org.glassfish.hk2.api.Descriptor.getDescriptorVisibility.

Returns the visibility of this descriptor.

If the visibility is NORMAL then this descriptor may be seen by all children locators of the locator in which this descriptor is bound

If the visibility is LOCAL then this descriptor may only be seen by the servcie locator in which it is bound, and in none of the children of that locator

Annotations

@Override

getFactoryDescriptor	back to summary
private ActiveDescriptor<?> getFactoryDescriptor(Method provideMethod, Type factoryProvidedType, ServiceLocatorImpl locator, Collector collector)

getFactoryLocatorId	back to summary
public Long getFactoryLocatorId() Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryLocatorId. Doc from org.glassfish.hk2.api.ActiveDescriptor.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 Annotations @Override

getFactoryLocatorId

back to summary

public Long getFactoryLocatorId()

Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryLocatorId.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

getFactoryServiceId	back to summary
public Long getFactoryServiceId() Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryServiceId. Doc from org.glassfish.hk2.api.ActiveDescriptor.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 Annotations @Override

getFactoryServiceId

back to summary

public Long getFactoryServiceId()

Implements org.glassfish.hk2.api.ActiveDescriptor.getFactoryServiceId.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

getImplementation	back to summary
public String getImplementation() Implements org.glassfish.hk2.api.Descriptor.getImplementation. Doc from org.glassfish.hk2.api.Descriptor.getImplementation. 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. Annotations @Override

getImplementation

back to summary

public String getImplementation()

Implements org.glassfish.hk2.api.Descriptor.getImplementation.

Doc from org.glassfish.hk2.api.Descriptor.getImplementation.

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.

Annotations

@Override

getImplementationClass	back to summary
public Class<?> getImplementationClass() Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationClass. Doc from org.glassfish.hk2.api.ActiveDescriptor.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 Annotations @Override

getImplementationClass

back to summary

public Class<?> getImplementationClass()

Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationClass.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

getImplementationType back to summary

getImplementationType	back to summary
public Type getImplementationType() Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationType. Doc from org.glassfish.hk2.api.ActiveDescriptor.getImplementationType. If known the Type of the implementation. If unknown will return the same as `getImplementationClass()` Annotations @Override

public Type getImplementationType()

Implements org.glassfish.hk2.api.ActiveDescriptor.getImplementationType.

Doc from org.glassfish.hk2.api.ActiveDescriptor.getImplementationType.

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

Annotations

@Override

getInjectees	back to summary
public List<Injectee> getInjectees() Implements org.glassfish.hk2.api.ActiveDescriptor.getInjectees. Doc from org.glassfish.hk2.api.ActiveDescriptor.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 Annotations @Override

getInjectees

back to summary

public List<Injectee> getInjectees()

Implements org.glassfish.hk2.api.ActiveDescriptor.getInjectees.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

getLoader	back to summary
public HK2Loader getLoader() Implements org.glassfish.hk2.api.Descriptor.getLoader. Doc from org.glassfish.hk2.api.Descriptor.getLoader. This returns the loader that should be used when classloading this descriptor. If this method returns null then the class will be loaded with the classloader of the Injectee if there is one, or with the classloader that loaded HK2 itself; failing that the context class loader on the thread will be tried. Annotations @Override

getLoader

back to summary

public HK2Loader getLoader()

Implements org.glassfish.hk2.api.Descriptor.getLoader.

Doc from org.glassfish.hk2.api.Descriptor.getLoader.

This returns the loader that should be used when classloading this descriptor. If this method returns null then the class will be loaded with the classloader of the Injectee if there is one, or with the classloader that loaded HK2 itself; failing that the context class loader on the thread will be tried.

Annotations

@Override

getLocatorId

back to summary

public Long getLocatorId()

Implements org.glassfish.hk2.api.Descriptor.getLocatorId.

Doc from org.glassfish.hk2.api.Descriptor.getLocatorId.

This returns the id of the ServiceLocator which this descriptor is registered with. Returns null if this descriptor is not yet registered with a ServiceLocator

Annotations

@Override

getMetadata

back to summary

public Map<String, List<String>> getMetadata()

Implements org.glassfish.hk2.api.Descriptor.getMetadata.

Doc from org.glassfish.hk2.api.Descriptor.getMetadata.

Returns all of the metadata associated that this object should be registered with or looked up by

Annotations

@Override

getName

back to summary

public String getName()

Implements org.glassfish.hk2.api.Descriptor.getName.

Doc from org.glassfish.hk2.api.Descriptor.getName.

The name of this descriptor. Note that if this returns not null then there must also be the Named qualifier in the set of qualifiers with the same value

Annotations

@Override

getPreAnalyzedClass	back to summary
pack-priv Class<?> getPreAnalyzedClass()

getQualifierAnnotations

back to summary

public Set<Annotation> getQualifierAnnotations()

Implements org.glassfish.hk2.api.ActiveDescriptor.getQualifierAnnotations.

Doc from org.glassfish.hk2.api.ActiveDescriptor.getQualifierAnnotations.

The full set of qualifiers that this ActiveDescriptor provides

Annotations

@Override

getQualifiers

back to summary

public Set<String> getQualifiers()

Implements org.glassfish.hk2.api.Descriptor.getQualifiers.

Doc from org.glassfish.hk2.api.Descriptor.getQualifiers.

Returns all of the annotation classes that this object should be registered with or looked up by

Annotations

@Override

getRanking

back to summary

public int getRanking()

Implements org.glassfish.hk2.api.Descriptor.getRanking.

Doc from org.glassfish.hk2.api.Descriptor.getRanking.

Returns the ranking of this descriptor. Rankings with higher value will be considered "better" than rankings of lower value. Descriptors with the same ranking will be returned in the reverse ServiceID order (in other words, the least service ID is considered "better" than any higher service ID).

Annotations

@Override

getScope

back to summary

public String getScope()

Implements org.glassfish.hk2.api.Descriptor.getScope.

Doc from org.glassfish.hk2.api.Descriptor.getScope.

Returns the fully qualified class name of the scope annotation that should be associated with this descriptor.

Annotations

@Override

getScopeAnnotation

back to summary

public Class<? extends Annotation> getScopeAnnotation()

Implements org.glassfish.hk2.api.ActiveDescriptor.getScopeAnnotation.

Doc from org.glassfish.hk2.api.ActiveDescriptor.getScopeAnnotation.

Returns the scope that this ActiveDescriptor belongs to

Annotations

@Override

getScopeAsAnnotation back to summary

public Annotation getScopeAsAnnotation()

Implements org.glassfish.hk2.api.ActiveDescriptor.getScopeAsAnnotation.

Doc from org.glassfish.hk2.api.ActiveDescriptor.getScopeAsAnnotation.

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

Annotations

@Override

getServiceId

back to summary

public Long getServiceId()

Implements org.glassfish.hk2.api.Descriptor.getServiceId.

Doc from org.glassfish.hk2.api.Descriptor.getServiceId.

This returns the unique identifier for this descriptor. This field will be ignored upon binding, and will then be assigned by the system. However, this field can be set on search operations, in which case this search will match exactly one Provider in the system.

Annotations

@Override

getSingletonGeneration	back to summary
pack-priv int getSingletonGeneration()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

internalReify

back to summary

private void internalReify(Class<?> implClass, Collector collector)

The service locator must hold its lock for this cal

Parameters

implClass:Class<?>: The impl class to reify
collector:Collector: An error collector for errors

invokeInstanceListeners	back to summary
pack-priv void invokeInstanceListeners(InstanceLifecycleEvent event)

isCacheSet

back to summary

public boolean isCacheSet()

Implements org.glassfish.hk2.api.SingleCache.isCacheSet.

Doc from org.glassfish.hk2.api.SingleCache.isCacheSet.

Returns true if this cache has been set

Annotations

@Override

isClosed

back to summary

public boolean isClosed()

Implements org.jvnet.hk2.internal.Closeable.isClosed.

Doc from org.jvnet.hk2.internal.Closeable.isClosed.

Returns true if the instance has been closed

Annotations

@Override

isProxiable back to summary

public Boolean isProxiable()

Implements org.glassfish.hk2.api.Descriptor.isProxiable.

Doc from org.glassfish.hk2.api.Descriptor.isProxiable.

If this returns true then the system will create a proxy for instances of this descriptor. As with all proxies, the proxy created will also implement the ProxyCtl interface

It is an error for this method to return true if the scope that this descriptor is in is Unproxiable (such as PerLookup).

Annotations

@Override

isProxyForSameScope

back to summary

public Boolean isProxyForSameScope()

Implements org.glassfish.hk2.api.Descriptor.isProxyForSameScope.

Doc from org.glassfish.hk2.api.Descriptor.isProxyForSameScope.

This value determines whether or not this service should be proxied when being injected into other services of the same scope. If a scope is proxiable then it will have a default setting for whether or not its services should be proxied when being injected into the same scope. If this method returns null then the default setting for the scope will be used. Otherwise the value returned will determine whether or not this service will be proxied when being injected into a service of the same scope.

Annotations

@Override

isReified

back to summary

public boolean isReified()

Implements org.glassfish.hk2.api.ActiveDescriptor.isReified.

Doc from org.glassfish.hk2.api.ActiveDescriptor.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

Annotations

@Override

isValidating

back to summary

pack-priv boolean isValidating(ValidationService service)

Gets the decision of the filter from this service. May use a cache

Parameters

service:ValidationService: The service to get the isValidating decision from

Returns:boolean

true if this validation service should validate this descriptor

reify	back to summary
pack-priv void reify(Class<?> implClass, Collector collector)

releaseCache

back to summary

public void releaseCache()

Implements org.glassfish.hk2.api.SingleCache.releaseCache.

Doc from org.glassfish.hk2.api.SingleCache.releaseCache.

Removes the cached value and makes it such that this cache has not been set

Annotations

@Override

removeList	back to summary
pack-priv void removeList(IndexedListData indexedList)

reupInstanceListeners	back to summary
pack-priv void reupInstanceListeners(List<InstanceLifecycleListener> listeners)

setCache

back to summary

public void setCache(T cacheMe)

Implements org.glassfish.hk2.api.SingleCache.setCache.

Doc from org.glassfish.hk2.api.SingleCache.setCache.

Sets the value into the cache

Annotations

@Override

setFactoryIds	back to summary
pack-priv void setFactoryIds(Long factoryLocatorId, Long factoryServiceId)

setRanking

back to summary

public int setRanking(int ranking)

Implements org.glassfish.hk2.api.Descriptor.setRanking.

Doc from org.glassfish.hk2.api.Descriptor.setRanking.

The ranking of a service may change at any time during the life of the descriptor

Annotations

@Override

setRankWithLock	back to summary
pack-priv int setRankWithLock(int ranking)

setSingletonGeneration	back to summary
pack-priv void setSingletonGeneration(int gen)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class SystemDescriptor<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail