org.glassfish.hk2.utilities.binding
Interface ScopedBindingBuilder<T>

Type Parameters:
T - service type.
All Superinterfaces:
BindingBuilder<T>

public interface ScopedBindingBuilder<T>
extends BindingBuilder<T>

Scoped service binding builder.

Author:
Marek Potociar (marek.potociar at oracle.com)

Method Summary
 ScopedBindingBuilder<T> loadedBy(HK2Loader loader)
          Custom HK2 loader to be used when service class is about to be loaded.
 ScopedNamedBindingBuilder<T> named(java.lang.String name)
          Name the binding.
 ScopedBindingBuilder<T> qualifiedBy(java.lang.annotation.Annotation annotation)
          Add a binging qualifier annotation.
 void ranked(int rank)
          Rank the binding.
 ScopedBindingBuilder<T> to(java.lang.Class<? super T> contract)
          Bind a new contract to a service.
 ScopedBindingBuilder<T> to(TypeLiteral<?> contract)
          Bind a new contract to a service.
 ScopedBindingBuilder<T> withMetadata(java.lang.String key, java.util.List<java.lang.String> values)
          Add binding descriptor metadata.
 ScopedBindingBuilder<T> withMetadata(java.lang.String key, java.lang.String value)
          Add binding descriptor metadata.
 

Method Detail

to

ScopedBindingBuilder<T> to(java.lang.Class<? super T> contract)
Bind a new contract to a service.

Parameters:
contract - contract type.
Returns:
updated binder.

to

ScopedBindingBuilder<T> to(TypeLiteral<?> contract)
Bind a new contract to a service.

Parameters:
contract - contract type.
Returns:
updated binder.

loadedBy

ScopedBindingBuilder<T> loadedBy(HK2Loader loader)
Custom HK2 loader to be used when service class is about to be loaded.

Parameters:
loader - custom service loader.
Returns:
updated binder.

withMetadata

ScopedBindingBuilder<T> withMetadata(java.lang.String key,
                                     java.lang.String value)
Add binding descriptor metadata. The metadata can be later used to e.g. filter binding descriptors.

Parameters:
key - metadata key.
value - metadata value.
Returns:
updated binder.

withMetadata

ScopedBindingBuilder<T> withMetadata(java.lang.String key,
                                     java.util.List<java.lang.String> values)
Add binding descriptor metadata. The metadata can be later used to e.g. filter binding descriptors.

Parameters:
key - metadata key.
values - metadata values.
Returns:
updated binder.

qualifiedBy

ScopedBindingBuilder<T> qualifiedBy(java.lang.annotation.Annotation annotation)
Add a binging qualifier annotation.

Parameters:
annotation - qualifier annotation.
Returns:
updated binder.

named

ScopedNamedBindingBuilder<T> named(java.lang.String name)
Name the binding.

Parameters:
name - new name value.
Returns:
updated binding.

ranked

void ranked(int rank)
Rank the binding. The higher rank, the more prominent position in an injected iterable provider for a contract.

Parameters:
rank - binding rank to be used to resolve ordering in case of multiple services are bound to the same contract.


Copyright © 2012 Oracle Corporation. All Rights Reserved.