com.sun.hk2.component
Class AbstractCreatorInhabitantImpl<T>

java.lang.Object
  com.sun.hk2.component.AbstractInhabitantImpl<T>
      com.sun.hk2.component.AbstractCreatorInhabitantImpl<T>

All Implemented Interfaces:

Holder<T>, Binding<T>, Factory<T>, ManagedComponentProvider<T>, Provider<T>, Releasable, Inhabitant<T>

Direct Known Subclasses:

ScopedInhabitant, SingletonInhabitant

public abstract class AbstractCreatorInhabitantImpl<T>
extends AbstractInhabitantImpl<T>

Partial implementation of Inhabitant that delegates to Creator for object creation.

Derived types are expected to implement the AbstractInhabitantImpl.get() method and choose when to create an object.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.hk2.component.Holder

Holder.Impl<T>

Field Summary

protected Creator<T>

creator

Fields inherited from class com.sun.hk2.component.AbstractInhabitantImpl

descriptor, logger

Constructor Summary

protected	AbstractCreatorInhabitantImpl(Creator<T> creator)
	AbstractCreatorInhabitantImpl(Descriptor descriptor, Creator<T> creator)

Method Summary

Creator<T>	getCreator()
MultiMap<String,String>	metadata() Gets the metadata associated with this inhabitant.
Class<? extends T>	type() Type of the inhabitant.
String	typeName() The short-cut for type().getName() but this allows us to defer loading the actual types.

Methods inherited from class com.sun.hk2.component.AbstractInhabitantImpl

companions, dispose, get, getAnnotation, getAnnotation, getAnnotations, getByType, getDescriptor, getDescriptorFor, getProvider, getProvider, getSerializedMetadata, getSerializedMetadata, lead, matches, setCompanions, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvnet.hk2.component.Inhabitant

get, release

Methods inherited from interface org.glassfish.hk2.Provider

isActive

Field Detail

creator

protected final Creator<T> creator

Constructor Detail

AbstractCreatorInhabitantImpl

protected AbstractCreatorInhabitantImpl(Creator<T> creator)

AbstractCreatorInhabitantImpl

public AbstractCreatorInhabitantImpl(Descriptor descriptor,
                                     Creator<T> creator)

Method Detail

typeName

public final String typeName()

Description copied from interface: Inhabitant

The short-cut for type().getName() but this allows us to defer loading the actual types.

type

public final Class<? extends T> type()

Description copied from interface: Inhabitant

Type of the inhabitant.

The only binding contract that needs to be honored is that the Inhabitant.get() method returns an instance assignable to this type. That is, get().getClass()==type() doesn't necessarily have to hold, but type().isInstance(get()) must.

This is particularly true when Factory is involved, as in such case HK2 has no way of knowing the actual type. That said, this method is not designed for the semantics of contract/implementation split --- implementations of a contract should return the concrete type from this method, and use habitat index to support look-up by contract.

Returns:

Always non-null, same value.

metadata

public MultiMap<String,String> metadata()

Description copied from interface: Inhabitant

Gets the metadata associated with this inhabitant.

This data is usually used by a sub-system of HK2, and not really meant to be used by applications. (At least for now.) The main benefit of metadata is that it's available right away as soon as the Habitat is properly initialized, even before component classes are loaded. In contrast, accessing annotations would require classes to be loaded and resolved.

Returns:

can be empty but never null. The values are read-only.

See Also:

Service.metadata()

getCreator

public Creator<T> getCreator()