A B C D E F G H I K L M N O P R S T W

A

all() - Method in interface org.glassfish.hk2.Providers
Return all applicable Providers.
annotatedWith(Class<? extends Annotation>) - Method in interface org.glassfish.hk2.ContractLocator
Qualify this ContractLocator to identify services have the given annotation.
annotatedWith(Class<? extends Annotation>) - Method in interface org.glassfish.hk2.NamedBinder
Append annotation to the binding.
AsyncPostConstruct - Interface in org.glassfish.hk2
Some service's PostConstruct may optionally spawn internal initializations on separate threads.

B

bind(String) - Method in interface org.glassfish.hk2.BinderFactory
Binds a service using a String interface name.
bind(String...) - Method in interface org.glassfish.hk2.BinderFactory
Starts the binding process of a service using String interfaces names that can be used to lookup the service.
bind(Class<T>, Class<?>...) - Method in interface org.glassfish.hk2.BinderFactory
Starts a binding process of a service using at least one interface or abstract class Class reference.
bind(TypeLiteral<T>) - Method in interface org.glassfish.hk2.BinderFactory
Binds a parameterized type by forcing users to create a subclass of TypeLiteral which will allow HK2 to retrieve the parameterized type at runtime.
bind() - Method in interface org.glassfish.hk2.BinderFactory
Binds a service which does not implement a contract or interface that can be used to look it up.
bindDynamically() - Method in interface org.glassfish.hk2.Services
Allow dynamic additions to this service registry.
Binder<T> - Interface in org.glassfish.hk2
A binder instance can be used to customize a binding by providing a name for the bound service.
BinderFactory - Interface in org.glassfish.hk2
Factory for adding services instances to a Services.
Binding<T> - Interface in org.glassfish.hk2
A Binding represents a single registered entry in the HK2 Services registry that provides a facility to get to contextual provider instances.
Bindings - Interface in org.glassfish.hk2
This represents the result of dynamically binding [services] to the underlying Services instance.
build() - Method in interface org.jvnet.hk2.annotations.Builder
 
Builder<T> - Interface in org.jvnet.hk2.annotations
Simple builder contract
byType(Class<U>) - Method in interface org.glassfish.hk2.Locator
Retrieve a service locator via a concrete service class type.
byType(String) - Method in interface org.glassfish.hk2.Locator
See Locator.forContract(Class), with the exception that the type is provided as a string instead of a class instance.

C

commit() - Method in interface org.glassfish.hk2.DynamicBinderFactory
Commits all the binders to the Services registry.
ComponentException - Exception in org.glassfish.hk2
Exception thrown when a component's dependency is not satisfied at the time the component is expected to be put in commission.
ComponentException(String) - Constructor for exception org.glassfish.hk2.ComponentException
 
ComponentException(Throwable) - Constructor for exception org.glassfish.hk2.ComponentException
 
ComponentException(String, Throwable) - Constructor for exception org.glassfish.hk2.ComponentException
 
ComponentException(String, Object...) - Constructor for exception org.glassfish.hk2.ComponentException
 
configure(BinderFactory) - Method in interface org.glassfish.hk2.Module
Main configuration hook for modules.
contains(K, V) - Method in interface org.glassfish.hk2.MultiMap
Checks if the map contains the given key(s), also extending the search to including the sub collection.
containsKey(K) - Method in interface org.glassfish.hk2.MultiMap
Checks if the map contains the given key.
Context - Interface in org.glassfish.hk2
Used by Binding to describe how the Binding's Provider will be used.
Contract - Annotation Type in org.jvnet.hk2.annotations
Marker annotation to allow implementations to be discovered from the contract they implement.
ContractLocator<T> - Interface in org.glassfish.hk2
Provides a means to locate services in the HK2 services registry by contract.
ContractProvided - Annotation Type in org.jvnet.hk2.annotations
A service provider provides a service implementation, however, the provided service interface is not tagged with @Contract (a jdk interface for instance), therefore, it is specified through this annotation.
create(Services, Class<? extends Module>...) - Method in class org.glassfish.hk2.HK2
Creates a new Services instances to register and lookup services to and from.
create(Services, Module...) - Method in class org.glassfish.hk2.HK2
Creates a new Services instances to register and lookup services to and from.
create(Services, Class<? extends Module>...) - Method in interface org.glassfish.hk2.spi.HK2Provider
HK2.create(org.glassfish.hk2.Services, Class[])
create(Services, Module...) - Method in interface org.glassfish.hk2.spi.HK2Provider
HK2.create(org.glassfish.hk2.Services, org.glassfish.hk2.Module...)
Creator - Interface in org.glassfish.hk2.inject
 
current() - Method in interface org.glassfish.hk2.Scope
 
current() - Method in class org.glassfish.hk2.scopes.PerLookup
 
current() - Method in class org.glassfish.hk2.scopes.PerThread
 
current() - Method in class org.glassfish.hk2.scopes.Singleton
Deprecated. Singleton instances are not stored in a single map.

D

Decorate - Annotation Type in org.jvnet.hk2.annotations
Decorates a Method with all the annotation which types are specified using the Decorate.with().
Descriptor - Interface in org.glassfish.hk2
A Descriptor is a bean-like structure that describes a service declaration in HK2.
DynamicBinderFactory - Interface in org.glassfish.hk2
Sub interfaces of the BinderFactory to allow dynamic registration of services.

E

entrySet() - Method in interface org.glassfish.hk2.MultiMap
The complete read-only entry set.
equals(Object) - Method in class org.glassfish.hk2.TypeLiteral
 

F

Factory<T> - Interface in org.glassfish.hk2
Provides an instance of T either by creating a new one at each request or by returning an existing one.
Factory - Annotation Type in org.jvnet.hk2.annotations
Indicates that the object should be created by using the given factory component, instead of calling the constructor.
FactoryFor - Annotation Type in org.jvnet.hk2.annotations
Indicates that the component serves as a factory for the specified type(s).
forContract(Class<U>) - Method in interface org.glassfish.hk2.Locator
Retrieve a service locator via a contract class.
forContract(String) - Method in interface org.glassfish.hk2.Locator
See Locator.forContract(Class), with the exception that the type is provided as a string instead of a class instance.
forContract(TypeLiteral<U>) - Method in interface org.glassfish.hk2.Locator
See Locator.forContract(Class), with the exception that the type is a TypeLiteral, a parameterized type.

G

get() - Method in interface org.glassfish.hk2.Factory
The system calls this method to obtain a reference to the component/service.
get() - Static method in class org.glassfish.hk2.HK2
Entry point to the HK2 public APIs, will initialize the implementation and return a valid instance that can be used to configure modules bindings.
get(K) - Method in interface org.glassfish.hk2.MultiMap
Returns the elements indexed by the provided key
get() - Method in interface org.glassfish.hk2.Provider
The system calls this method to obtain a reference to the component/service.
get() - Method in interface org.glassfish.hk2.Providers
A shortcut for
get(Provider<T>) - Method in interface org.glassfish.hk2.ScopeInstance
Retrieves a stored inhabitant if present in the storage bag.
getAnnotations() - Method in interface org.glassfish.hk2.Provider
The collection of annotations for this type.
getBindings() - Method in interface org.glassfish.hk2.Services
Retrieve the collection of all registered bindings in this instance as well as in the parent service instance(s).
getBindings(Descriptor) - Method in interface org.glassfish.hk2.Services
Retrieve the collection of existing bindings in this as well as in parent service registries that matches the Descriptor.
getContracts() - Method in interface org.glassfish.hk2.Descriptor
The contracts that are used to index the service definition.
getDeclaredBindings() - Method in interface org.glassfish.hk2.Services
Retrieve the collection of all registered bindings in this, and only this, Services instance.
getDeclaredBindings(Descriptor) - Method in interface org.glassfish.hk2.Services
Retrieve the collection of registered bindings in this, and only this, Services instance that match the Descriptor argument.
getDefault() - Method in interface org.glassfish.hk2.Services
Retrieves the default Services registry.
getDescriptor() - Method in interface org.glassfish.hk2.Binding
The Descriptor fully characterizes the attributes of this Provider.
getFirst(K) - Method in interface org.glassfish.hk2.MultiMap
Gets the first value if any, or null.
getInjectionPoint() - Method in interface org.glassfish.hk2.Context
The injection point information.
getMetadata() - Method in interface org.glassfish.hk2.Descriptor
The meta data attributes for the service.
getNames() - Method in interface org.glassfish.hk2.Descriptor
The name(s) for the service.
getParameterTypes() - Method in class org.glassfish.hk2.TypeLiteral
 
getProvider(Context) - Method in interface org.glassfish.hk2.Binding
Return a Provider optionally providing contextual information for how the component provider will be used (e.g., for contextual injection, etc).
getProvider() - Method in interface org.glassfish.hk2.Binding
Return a Provider with providing contextual information on how the provider will be used.
getProvider() - Method in interface org.glassfish.hk2.Providers
Return the "best" Provider from the collection that matches current criteria.
getQualifiers() - Method in interface org.glassfish.hk2.Descriptor
Returns the qualifier annotations on the service.
getRawType() - Method in class org.glassfish.hk2.TypeLiteral
 
getRawType(Type) - Static method in class org.glassfish.hk2.TypeLiteral
 
getScope() - Method in interface org.glassfish.hk2.Descriptor
The optional scoping for the service.
getServices(String) - Method in interface org.glassfish.hk2.Services
Retrieves the service registry given a module name.
getType() - Method in class org.glassfish.hk2.TypeLiteral
 
getTypeName() - Method in interface org.glassfish.hk2.Descriptor
The implementation definition type.

H

hasContract(String) - Method in interface org.glassfish.hk2.Descriptor
Returns true if Descriptor.getContracts() contains the passed argument.
hashCode() - Method in class org.glassfish.hk2.TypeLiteral
 
hasName(String) - Method in interface org.glassfish.hk2.Descriptor
Returns true if Descriptor.getNames() contains the passed argument.
hasQualifier(String) - Method in interface org.glassfish.hk2.Descriptor
Returns true if Descriptor.getQualifiers() contains the passed argument.
HK2 - Class in org.glassfish.hk2
Entry point to the HK2 services runtime.
HK2(HK2Provider) - Constructor for class org.glassfish.hk2.HK2
Provides an HK2 APIs implementation using the provided HK2Provider instance as the implementation backend.
HK2Provider - Interface in org.glassfish.hk2.spi
SPI for providing an implementation of the HK2 APIs.

I

Immediate - Annotation Type in org.jvnet.hk2.annotations
The RunLevel that indicates immediate activation for the default run level scope.
in(Scope) - Method in interface org.glassfish.hk2.ContractLocator
Qualify this ContractLocator to identify services that are scoped scope.
in(Class<? extends Scope>) - Method in interface org.glassfish.hk2.ResolvedBinder
Ascribe a scope to this Binder, terminating the builder-like process.
Index - Annotation Type in org.jvnet.hk2.annotations
Marks the index property of the Contract annotations.
InhabitantAnnotation - Annotation Type in org.jvnet.hk2.annotations
Meta-annotation indicating that the annotation designates a resident service of a Services.
InhabitantMetadata - Annotation Type in org.jvnet.hk2.annotations
Meta-annotation to make annotation values readable as org.glassfish.hk2.Descriptor#metadata().
inject(T) - Method in interface org.glassfish.hk2.inject.Injector
Injects all the Inject annotated fields and methods of the passed instance.
inject(Class<T>) - Method in interface org.glassfish.hk2.inject.Injector
Instantiate the passed type and injects all the Inject annotated fields and methods
Inject - Annotation Type in org.jvnet.hk2.annotations
Annotation to define a required resource for a component.
InjectionPoint - Interface in org.glassfish.hk2.inject
 
Injector - Interface in org.glassfish.hk2.inject
Defines a simple API for injecting HK2 components
inParent() - Method in interface org.glassfish.hk2.BinderFactory
Return the parent binder factory instance which can be used to bind services for wider visibility outside of this module definition.
isActive() - Method in interface org.glassfish.hk2.Releasable
 
isDone() - Method in interface org.glassfish.hk2.AsyncPostConstruct
Returns true if the service is fully ready to have methods called on it.

K

KERNEL_RUNLEVEL - Static variable in annotation type org.jvnet.hk2.annotations.RunLevel
 
keySet() - Method in interface org.glassfish.hk2.MultiMap
Returns the keys of type K.

L

Locator - Interface in org.glassfish.hk2
This contract provides the starting point for querying HK2's backing service registry either by contract (e.g., classes annotated with @Contract) or by concrete service type (e.g., classes annotated with @Service).

M

ManagedComponentProvider<T> - Interface in org.glassfish.hk2
A ManagedComponentProvider is one in which its backing component that it provides can either be in an active or inactive state.
META_SCOPE_TAG - Static variable in annotation type org.jvnet.hk2.annotations.RunLevel
 
META_VAL_TAG - Static variable in annotation type org.jvnet.hk2.annotations.RunLevel
 
Module - Interface in org.glassfish.hk2
A module defines the binding for a Services instance.
MultiMap<K,V> - Interface in org.glassfish.hk2
A read-nly Map from a key to multiple values.
Multiple - Annotation Type in org.jvnet.hk2.annotations
Annotates an annotation which value is an array of inhabitant annotations InhabitantAnnotation

N

named(String) - Method in interface org.glassfish.hk2.Binder
Names a binding that will be used to register the service in the registry.
named(String) - Method in interface org.glassfish.hk2.ContractLocator
Qualify this ContractLocator to identify services that are named name.
NamedBinder<U> - Interface in org.glassfish.hk2
Provides a means to more fully describe a binding that has already been named, or where the name has been assumed to be left blank.
newValueObject(Class<T>) - Method in interface org.glassfish.hk2.inject.Creator
Creates a new value object which will be instantiated using the empty parameter constructor.

O

org.glassfish.hk2 - package org.glassfish.hk2
 
org.glassfish.hk2.inject - package org.glassfish.hk2.inject
 
org.glassfish.hk2.scopes - package org.glassfish.hk2.scopes
 
org.glassfish.hk2.spi - package org.glassfish.hk2.spi
 
org.jvnet.hk2.annotations - package org.jvnet.hk2.annotations
HK2 annotations that mark components and their required dependencies. Primary API surface of HK2.

P

PerLookup - Class in org.glassfish.hk2.scopes
Scope local to each invocation.
PerLookup() - Constructor for class org.glassfish.hk2.scopes.PerLookup
 
PerThread - Class in org.glassfish.hk2.scopes
Implementation of an HK2 Scope that will instantiate and store services per thread.
PerThread() - Constructor for class org.glassfish.hk2.scopes.PerThread
 
PostConstruct - Interface in org.glassfish.hk2
Classes implementing this interface register an interest in being notified when the instance has been created and the component is about to be place into commission.
postConstruct() - Method in interface org.glassfish.hk2.PostConstruct
The component has been injected with any dependency and will be placed into commission by the subsystem.
PreDestroy - Interface in org.glassfish.hk2
Components implementing this interface registers an interest in being notified when they are about to be decommissioned.
preDestroy() - Method in interface org.glassfish.hk2.PreDestroy
The component is about to be removed from the registry.
Priority - Annotation Type in org.jvnet.hk2.annotations
Deprecated. Not fully supported in Hk2
Provider<T> - Interface in org.glassfish.hk2
Similar to the Factory contract, providing a means to access the class type instance.
Providers<T> - Interface in org.glassfish.hk2
This contract provides a means to access runtime component providers.
put(Provider<T>, T) - Method in interface org.glassfish.hk2.ScopeInstance
Stores a inhabitant component instance.

R

Releasable - Interface in org.glassfish.hk2
Represents something that can be active or inactive, and released.
release() - Method in interface org.glassfish.hk2.Releasable
Release the component/service if active.
release() - Method in interface org.glassfish.hk2.ScopeInstance
release the backend storage and call PreDestroy.preDestroy() on all instantiated components that implement the PreDestroy interface.
release() - Method in class org.glassfish.hk2.scopes.PerThread
 
ResolvedBinder<T> - Interface in org.glassfish.hk2
This contract is used to apply scope to an otherwise described / resolved Binder.
RunLevel - Annotation Type in org.jvnet.hk2.annotations
Defines a run/start level.
RunLevelDefaultScope - Interface in org.glassfish.hk2
Marker interface signifying the default RunLevel scope.

S

Scope - Interface in org.glassfish.hk2
 
Scoped - Annotation Type in org.jvnet.hk2.annotations
Indicates the scope that this managed object is tied to.
ScopeInstance - Interface in org.glassfish.hk2
A particular instantiation of a Scope.
Service - Annotation Type in org.jvnet.hk2.annotations
Marker interface for service implementation.
ServiceLocator<T> - Interface in org.glassfish.hk2
A ServiceLocator provides runtime access to a particular service in HK2.
ServiceProvider - Annotation Type in org.jvnet.hk2.annotations
Denotes the service provider implementation.
Services - Interface in org.glassfish.hk2
Services is the registry for HK2 services.
Singleton - Class in org.glassfish.hk2.scopes
Singleton scope.
Singleton() - Constructor for class org.glassfish.hk2.scopes.Singleton
 
size() - Method in interface org.glassfish.hk2.MultiMap
Returns the size of the map.

T

to(String) - Method in interface org.glassfish.hk2.NamedBinder
Have this instance resolve to a particular target implementation class name.
to(Class<? extends T>) - Method in interface org.glassfish.hk2.NamedBinder
Resolve this binder to a particular target implementation class type.
to(TypeLiteral<T>) - Method in interface org.glassfish.hk2.NamedBinder
Resolve this binder to a particular parameterized type.
toFactory(Factory<T>) - Method in interface org.glassfish.hk2.NamedBinder
Have this instance resolve to a particular target factory implementation.
toFactory(Class<? extends Factory<? extends T>>) - Method in interface org.glassfish.hk2.NamedBinder
Have this instance resolve to a particular target factory class type.
toFactory(TypeLiteral<? extends Factory<? extends T>>) - Method in interface org.glassfish.hk2.NamedBinder
Have this instance resolve to a particular target type literal factory.
toInstance(T) - Method in interface org.glassfish.hk2.NamedBinder
Have this instance resolve to a particular singleton implementation instance.
toString() - Method in class org.glassfish.hk2.TypeLiteral
 
type() - Method in interface org.glassfish.hk2.Provider
The class type of the implementation.
TypeLiteral<T> - Class in org.glassfish.hk2
Supports inline instantiation of objects that represent parameterized types with actual type parameters.
TypeLiteral() - Constructor for class org.glassfish.hk2.TypeLiteral
 

W

waitForDone() - Method in interface org.glassfish.hk2.AsyncPostConstruct
The implementation should block until the service is fully ready / initialized.
waitForDone(long, TimeUnit) - Method in interface org.glassfish.hk2.AsyncPostConstruct
The implementation should return true immediately if the service is fully ready / initialized.

A B C D E F G H I K L M N O P R S T W

Copyright © 2011 Oracle Corporation. All Rights Reserved.