Top Description Fields Constructors Methods
org.glassfish.hk2.internal

public Class DescriptorBuilderImpl

extends Object
implements DescriptorBuilder
Class Inheritance
All Implemented Interfaces
org.glassfish.hk2.utilities.DescriptorBuilder
Imports
java.lang.annotation.Annotation, java.util.Collections, .HashMap, .HashSet, .List, .LinkedList, .Map, .Set, jakarta.inject.Named, org.glassfish.hk2.api.DescriptorType, .DescriptorVisibility, .Factory, .FactoryDescriptors, .HK2Loader, .PerLookup, org.glassfish.hk2.utilities.DescriptorBuilder, .DescriptorImpl, .FactoryDescriptorsImpl
This is a simple implementation of the DescriptorBuilder
Author
jwells

Field Summary

Modifier and TypeField and Description
private String
analysisName

private final HashSet<String>
contracts

private String
implementation

private HK2Loader
loader

private final HashMap<String, List<String>>
metadatas

private String
name

private Boolean
proxy

private Boolean
proxyForSameScope

private final HashSet<String>
qualifiers

private int
rank

private String
scope

private DescriptorVisibility
visibility

Constructor Summary

AccessConstructor and Description
public
DescriptorBuilderImpl()

The basid constructor

public
DescriptorBuilderImpl(String
The implementation this should take
implementation, boolean
Whether or not to add the implementation to the set of contracts
addToContracts)

A descriptor builder with the given implementation

Method Summary

Modifier and TypeMethod and Description
public DescriptorBuilder
analyzeWith(String serviceName)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.analyzeWith.

Call this if the descriptor should be analyzed with the org.glassfish.hk2.api.ClassAnalyzer service of the given name

public DescriptorBuilder
andLoadWith(HK2Loader loader)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.andLoadWith.

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

public DescriptorImpl
build()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.build.

Generates a descriptor that can be used in binding operations

public FactoryDescriptors
buildFactory(String factoryScope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations.

public FactoryDescriptors
buildFactory()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations.

public FactoryDescriptors
buildFactory(Class<? extends Annotation> factoryScope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations.

public DescriptorBuilder
has(String key, String value)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.has.

An instance of data to be associated with this descriptor

public DescriptorBuilder
has(String key, List<String> values)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.has.

An instance of data to be associated with this descriptor

public DescriptorBuilder
in(Class<? extends Annotation> scope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.in.

A scope to be associated with this descriptor object.

public DescriptorBuilder
in(String scope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.in.

A scope to be associated with this descriptor object.

public DescriptorBuilder
localOnly()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.localOnly.

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

public DescriptorBuilder
named(String name)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.named.

The name for this descriptor object.

public DescriptorBuilder
ofRank(int rank)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.ofRank.

The rank to be associated with this descriptor.

public DescriptorBuilder
proxy()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

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

public DescriptorBuilder
proxy(boolean forceProxy)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

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

public DescriptorBuilder
proxyForSameScope()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

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

public DescriptorBuilder
proxyForSameScope(boolean proxyForSameScope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

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

public DescriptorBuilder
qualifiedBy(Annotation annotation)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

A qualifier to be associated with this descriptor object.

public DescriptorBuilder
qualifiedBy(String annotation)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

A qualifier to be associated with this descriptor object

public DescriptorBuilder
to(Class<?> contract)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.to.

A contract to be associated with this descriptor object.

public DescriptorBuilder
to(String contract)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.to.

A contract to be associated with this descriptor object.

public DescriptorBuilder
visibility(DescriptorVisibility visibility)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.visibility.

This will set the descriptorVisibility field of the returned descriptor

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

analysisNameback to summary
private String analysisName
contractsback to summary
private final HashSet<String> contracts
implementationback to summary
private String implementation
loaderback to summary
private HK2Loader loader
metadatasback to summary
private final HashMap<String, List<String>> metadatas
nameback to summary
private String name
proxyback to summary
private Boolean proxy
proxyForSameScopeback to summary
private Boolean proxyForSameScope
qualifiersback to summary
private final HashSet<String> qualifiers
rankback to summary
private int rank
scopeback to summary
private String scope
visibilityback to summary
private DescriptorVisibility visibility

Constructor Detail

DescriptorBuilderImplback to summary
public DescriptorBuilderImpl()

The basid constructor

DescriptorBuilderImplback to summary
public DescriptorBuilderImpl(String implementation, boolean addToContracts)

A descriptor builder with the given implementation

Parameters
implementation:String

The implementation this should take

addToContracts:boolean

Whether or not to add the implementation to the set of contracts

Method Detail

analyzeWithback to summary
public DescriptorBuilder analyzeWith(String serviceName)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.analyzeWith.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.analyzeWith.

Call this if the descriptor should be analyzed with the org.glassfish.hk2.api.ClassAnalyzer service of the given name

Annotations
@Override
andLoadWithback to summary
public DescriptorBuilder andLoadWith(HK2Loader loader) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.andLoadWith.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.andLoadWith.

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

Annotations
@Override
Exceptions
IllegalArgumentException:
if the HK2Loader is set non-null more than once
buildback to summary
public DescriptorImpl build() throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.build.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.build.

Generates a descriptor that can be used in binding operations

Annotations
@Override
Exceptions
IllegalArgumentException:
if the built descriptor is invalid
buildFactoryback to summary
public FactoryDescriptors buildFactory(String factoryScope) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations. The generated factory service will have no name, no qualifiers and the same metadata as given to this builder. The generated service will have had the implementation class removed from its set of advertised contracts

Annotations
@Override
Exceptions
IllegalArgumentException:
if the built descriptor is invalid
buildFactoryback to summary
public FactoryDescriptors buildFactory() throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations. The generated factory service will have no name, no qualifiers and the same metadata as given to this builder. The factory will be put into PerLookup scope

Annotations
@Override
Exceptions
IllegalArgumentException:
if the built descriptor is invalid
buildFactoryback to summary
public FactoryDescriptors buildFactory(Class<? extends Annotation> factoryScope) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.buildFactory.

Generates a factory descriptor that can be used in binding operations. The generated factory service will have no name, no qualifiers and the same metadata as given to this builder. The generated service will have had the implementation class removed from its set of advertised contracts

Annotations
@Override
Exceptions
IllegalArgumentException:
if the built descriptor is invalid
hasback to summary
public DescriptorBuilder has(String key, String value) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.has.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.has.

An instance of data to be associated with this descriptor

Annotations
@Override
hasback to summary
public DescriptorBuilder has(String key, List<String> values) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.has.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.has.

An instance of data to be associated with this descriptor

Annotations
@Override
inback to summary
public DescriptorBuilder in(Class<? extends Annotation> scope) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.in.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.in.

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.

Annotations
@Override
Exceptions
IllegalArgumentException:
If in is called more than once
inback to summary
public DescriptorBuilder in(String scope) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.in.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.in.

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.

Annotations
@Override
Exceptions
IllegalArgumentException:
If in is called more than once
localOnlyback to summary
public DescriptorBuilder localOnly()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.localOnly.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.localOnly.

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

Annotations
@Override
namedback to summary
public DescriptorBuilder named(String name) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.named.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.named.

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.

Annotations
@Override
Exceptions
IllegalArgumentException:
if there is more than one name on the predicate
ofRankback to summary
public DescriptorBuilder ofRank(int rank)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.ofRank.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.ofRank.

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

Annotations
@Override
proxyback to summary
public DescriptorBuilder proxy()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

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

Annotations
@Override
proxyback to summary
public DescriptorBuilder proxy(boolean forceProxy)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.proxy.

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

Annotations
@Override
proxyForSameScopeback to summary
public DescriptorBuilder proxyForSameScope()

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

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

Annotations
@Override
proxyForSameScopeback to summary
public DescriptorBuilder proxyForSameScope(boolean proxyForSameScope)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.proxyForSameScope.

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

Annotations
@Override
qualifiedByback to summary
public DescriptorBuilder qualifiedBy(Annotation annotation) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

A qualifier to be associated with this descriptor object. It is dangerous to use this method with a ghost annotation (one that is not on the object) if that annotation has fields, as these fields will NOT survive being put into the org.glassfish.hk2.api.Descriptor. Use this method with care and ONLY with annotations that do not have fields. A safe version of this method for use with ghost annotations is ActiveDescriptorBuilder#qualifiedBy(Annotation)

Annotations
@Override
Exceptions
IllegalArgumentException:
on failures
qualifiedByback to summary
public DescriptorBuilder qualifiedBy(String annotation) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.qualifiedBy.

A qualifier to be associated with this descriptor object

Annotations
@Override
Exceptions
IllegalArgumentException:
on failures
toback to summary
public DescriptorBuilder to(Class<?> contract) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.to.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.to.

A contract to be associated with this descriptor object.

Annotations
@Override
Exceptions
IllegalArgumentException:
on failures
toback to summary
public DescriptorBuilder to(String contract) throws IllegalArgumentException

Implements org.glassfish.hk2.utilities.DescriptorBuilder.to.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.to.

A contract to be associated with this descriptor object.

Annotations
@Override
Exceptions
IllegalArgumentException:
on failures
visibilityback to summary
public DescriptorBuilder visibility(DescriptorVisibility visibility)

Implements org.glassfish.hk2.utilities.DescriptorBuilder.visibility.

Doc from org.glassfish.hk2.utilities.DescriptorBuilder.visibility.

This will set the descriptorVisibility field of the returned descriptor

Annotations
@Override