Module org.glassfish.hk2.api

Package org.glassfish.hk2.internal

Class ActiveDescriptorBuilderImpl

java.lang.Object

org.glassfish.hk2.internal.ActiveDescriptorBuilderImpl

All Implemented Interfaces:

ActiveDescriptorBuilder

public class ActiveDescriptorBuilderImpl
extends Object
implements ActiveDescriptorBuilder

Author:

jwells

Constructor Summary

Constructors

Constructor	Description
ActiveDescriptorBuilderImpl(Class<?> implementation)	constructor with the impl class

Method Summary

Modifier and Type	Method	Description
ActiveDescriptorBuilder	analyzeWith(String serviceName)	Call this if the descriptor should be analyzed with the ClassAnalyzer service of the given name
ActiveDescriptorBuilder	andLoadWith(HK2Loader loader)	Call this if this descriptor should be loaded with the given HK2Loader
ActiveDescriptorBuilder	asType(Type t)	Call this if the parameterized type of the implementation class is known.
<T> AbstractActiveDescriptor<T>	build()	Generates a descriptor that can be used in binding operations
<T> AbstractActiveDescriptor<T>	buildFactory()	Deprecated.
<T> AbstractActiveDescriptor<T>	buildProvideMethod()	Generates a descriptor that can be used in binding operations that describes a factorys provide method
ActiveDescriptorBuilder	has(String key, String value)	An instance of data to be associated with this descriptor
ActiveDescriptorBuilder	has(String key, List<String> values)	An instance of data to be associated with this descriptor
ActiveDescriptorBuilder	in(Annotation scopeAnnotation)	A scope to be associated with this descriptor object.
ActiveDescriptorBuilder	in(Class<? extends Annotation> scope)	A scope to be associated with this descriptor object.
ActiveDescriptorBuilder	localOnly()	This will cause the descriptorVisibility field of the returned descriptor to return LOCAL
ActiveDescriptorBuilder	named(String name)	The name for this descriptor object.
ActiveDescriptorBuilder	ofRank(int rank)	The rank to be associated with this descriptor.
ActiveDescriptorBuilder	proxy()	This will cause the isProxiable field of the returned descriptor to return true (it will force this descriptor to use proxies).
ActiveDescriptorBuilder	proxy(boolean forceProxy)	This will cause the isProxiable field of the returned descriptor to return the given value.
ActiveDescriptorBuilder	proxyForSameScope()	This will cause the isProxyForSameScope field of the returned descriptor to return true (it will force this descriptor to use proxies even when injecting into the same scope).
ActiveDescriptorBuilder	proxyForSameScope(boolean forceProxyForSameScope)	This will cause the isProxyForSameScope field of the returned descriptor to return the given value.
ActiveDescriptorBuilder	qualifiedBy(Annotation annotation)	A qualifier to be associated with this descriptor object
ActiveDescriptorBuilder	to(Type contract)	A contract to be associated with this descriptor object.
ActiveDescriptorBuilder	visibility(DescriptorVisibility visibility)	This will set the descriptorVisibility field of the returned descriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ActiveDescriptorBuilderImpl

public ActiveDescriptorBuilderImpl(Class<?> implementation)

constructor with the impl class

Parameters:

implementation - The implementation class (may be null)

Method Details

named

public ActiveDescriptorBuilder named(String name)
                              throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

The name for this descriptor object. Note that at the current time a descriptor can only have one name, hence this method will throw an IllegalArgumentException if named is called more than once.

Specified by:

named in interface ActiveDescriptorBuilder

Parameters:

name - The name to be associated with this Descriptor

Returns:

A DescriptorBuilder with the given name

Throws:

IllegalArgumentException - if there is more than one name on the predicate

to

public ActiveDescriptorBuilder to(Type contract)
                           throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

A contract to be associated with this descriptor object.

Specified by:

to in interface ActiveDescriptorBuilder

Parameters:

contract - A class that is annotated with Contract to be associated with this Descriptor

Returns:

A DescriptorBuilder with the given name

Throws:

IllegalArgumentException - on failures

in

public ActiveDescriptorBuilder in(Annotation scopeAnnotation)
                           throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

A scope to be associated with this descriptor object. Note that at the current time a descriptor can only have one scope, hence this method will throw an IllegalArgumentException if in is called more than once.

Specified by:

in in interface ActiveDescriptorBuilder

Parameters:

scopeAnnotation - The class of the scope this descriptor is to have.

Returns:

A DescriptorBuilder with the given scope

Throws:

IllegalArgumentException - If in is called more than once

in

public ActiveDescriptorBuilder in(Class<? extends Annotation> scope)
                           throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

A scope to be associated with this descriptor object. Note that at the current time a descriptor can only have one scope, hence this method will throw an IllegalArgumentException if in is called more than once.

Specified by:

in in interface ActiveDescriptorBuilder

Parameters:

scope - The class of the scope this descriptor is to have.

Returns:

A DescriptorBuilder with the given scope

Throws:

IllegalArgumentException - If in is called more than once

qualifiedBy

public ActiveDescriptorBuilder qualifiedBy(Annotation annotation)
                                    throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

A qualifier to be associated with this descriptor object

Specified by:

qualifiedBy in interface ActiveDescriptorBuilder

Parameters:

annotation - The annotation to be associated with this descriptor

Returns:

A DescriptorBuilder with the given annotation

Throws:

IllegalArgumentException - on failures

has

public ActiveDescriptorBuilder has(String key,
 String value)
                            throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

An instance of data to be associated with this descriptor

Specified by:

has in interface ActiveDescriptorBuilder

Parameters:

key - The key for the data to be associated with this descriptor

value - The value this key should take (single value metadata)

Returns:

A DescriptorBuilder with the given metadata

Throws:

IllegalArgumentException

has

public ActiveDescriptorBuilder has(String key,
 List<String> values)
                            throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

An instance of data to be associated with this descriptor

Specified by:

has in interface ActiveDescriptorBuilder

Parameters:

key - The key for the data to be associated with this descriptor

values - The values this key should take (single value metadata)

Returns:

A DescriptorBuilder with the given metadata

Throws:

IllegalArgumentException

ofRank

public ActiveDescriptorBuilder ofRank(int rank)

Description copied from interface: ActiveDescriptorBuilder

The rank to be associated with this descriptor. The last rank bound wins

Specified by:

ofRank in interface ActiveDescriptorBuilder

Parameters:

rank - The rank to be associated with this descriptor.

Returns:

A DescriptorBuilder with the given rank

proxy

public ActiveDescriptorBuilder proxy()

Description copied from interface: ActiveDescriptorBuilder

This will cause the isProxiable field of the returned descriptor to return true (it will force this descriptor to use proxies).

Specified by:

proxy in interface ActiveDescriptorBuilder

Returns:

A DescriptorBuilder with the proxiable field set to true

proxy

public ActiveDescriptorBuilder proxy(boolean forceProxy)

Description copied from interface: ActiveDescriptorBuilder

This will cause the isProxiable field of the returned descriptor to return the given value.

Specified by:

proxy in interface ActiveDescriptorBuilder

Parameters:

forceProxy - if true then this descriptor will be proxied, if false then this descriptor will NOT be proxied

Returns:

A DescriptorBuilder with the proxiable field set to the given value

proxyForSameScope

public ActiveDescriptorBuilder proxyForSameScope()

Description copied from interface: ActiveDescriptorBuilder

This will cause the isProxyForSameScope field of the returned descriptor to return true (it will force this descriptor to use proxies even when injecting into the same scope).

Specified by:

proxyForSameScope in interface ActiveDescriptorBuilder

Returns:

A DescriptorBuilder with the proxyForSameScope field set to true

proxyForSameScope

public ActiveDescriptorBuilder proxyForSameScope(boolean forceProxyForSameScope)

Description copied from interface: ActiveDescriptorBuilder

This will cause the isProxyForSameScope field of the returned descriptor to return the given value.

Specified by:

proxyForSameScope in interface ActiveDescriptorBuilder

Parameters:

forceProxyForSameScope - if true then this descriptor will be proxied even if the scope of the injectee is the same, if false then this descriptor will NOT be proxied, even if the scope of the injectee is the same

Returns:

A DescriptorBuilder with the proxyForSameScope field set to the given value

andLoadWith

public ActiveDescriptorBuilder andLoadWith(HK2Loader loader)
                                    throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

Call this if this descriptor should be loaded with the given HK2Loader

Specified by:

andLoadWith in interface ActiveDescriptorBuilder

Parameters:

loader - The loader to use with this descriptor

Returns:

A DescriptorBuilder with the given HK2Loader

Throws:

IllegalArgumentException - if the HK2Loader is set non-null more than once

analyzeWith

public ActiveDescriptorBuilder analyzeWith(String serviceName)

Description copied from interface: ActiveDescriptorBuilder

Call this if the descriptor should be analyzed with the ClassAnalyzer service of the given name

Specified by:

analyzeWith in interface ActiveDescriptorBuilder

Parameters:

serviceName - the name of the ClassAnalyzer service that should be used to analyze this service

Returns:

A DescriptorBuilder with the given analysis service

localOnly

public ActiveDescriptorBuilder localOnly()

Description copied from interface: ActiveDescriptorBuilder

This will cause the descriptorVisibility field of the returned descriptor to return LOCAL

Specified by:

localOnly in interface ActiveDescriptorBuilder

Returns:

A DescriptorBuilder with the descriptorVisibility field to be set to LOCAL

visibility

public ActiveDescriptorBuilder visibility(DescriptorVisibility visibility)

Description copied from interface: ActiveDescriptorBuilder

This will set the descriptorVisibility field of the returned descriptor

Specified by:

visibility in interface ActiveDescriptorBuilder

Parameters:

visibility - The non-null visibility that this descriptor should take

Returns:

A DescriptorBuilder with the descriptorVisibility field set to the input value

asType

public ActiveDescriptorBuilder asType(Type t)

Description copied from interface: ActiveDescriptorBuilder

Call this if the parameterized type of the implementation class is known. This may be called with any Type, but only a ParameterizedType based on the implementationClass will work

Specified by:

asType in interface ActiveDescriptorBuilder

Parameters:

t - The non-null ParameterizedType describing the implementation

Returns:

A DescriptorBuilder with the given implementationType

build

public <T> AbstractActiveDescriptor<T> build()
                                      throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

Generates a descriptor that can be used in binding operations

Specified by:

build in interface ActiveDescriptorBuilder

Returns:

The descriptor that has been built up

Throws:

IllegalArgumentException - if the built descriptor is invalid

buildFactory

@Deprecated
public <T> AbstractActiveDescriptor<T> buildFactory()
                                             throws IllegalArgumentException

Deprecated.

Description copied from interface: ActiveDescriptorBuilder

Generates a descriptor that can be used in binding operations that describes a factorys provide method

Specified by:

buildFactory in interface ActiveDescriptorBuilder

Returns:

The descriptor that has been built up, of type PROVIDE_METHOD

Throws:

IllegalArgumentException - if the built descriptor is invalid

buildProvideMethod

public <T> AbstractActiveDescriptor<T> buildProvideMethod()
                                                   throws IllegalArgumentException

Description copied from interface: ActiveDescriptorBuilder

Generates a descriptor that can be used in binding operations that describes a factorys provide method

Specified by:

buildProvideMethod in interface ActiveDescriptorBuilder

Returns:

The descriptor that has been built up, of type PROVIDE_METHOD

Throws:

IllegalArgumentException - if the built descriptor is invalid