public interface DescriptorBuilder
Modifier and Type | Method and Description |
---|---|
DescriptorBuilder |
analyzeWith(String serviceName)
Call this if the descriptor should be analyzed with the
ClassAnalyzer service of the given name |
DescriptorBuilder |
andLoadWith(HK2Loader loader)
Call this if this descriptor should be loaded with the given HK2Loader
|
DescriptorImpl |
build()
Generates a descriptor that can be used in binding operations
|
FactoryDescriptors |
buildFactory()
Generates a factory descriptor that can be used in binding operations.
|
FactoryDescriptors |
buildFactory(Class<? extends Annotation> factoryScope)
Generates a factory descriptor that can be used in binding operations.
|
FactoryDescriptors |
buildFactory(String factoryScope)
Generates a factory descriptor that can be used in binding operations.
|
DescriptorBuilder |
has(String key,
List<String> values)
An instance of data to be associated with this descriptor
|
DescriptorBuilder |
has(String key,
String value)
An instance of data to be associated with this descriptor
|
DescriptorBuilder |
in(Class<? extends Annotation> scope)
A scope to be associated with this descriptor object.
|
DescriptorBuilder |
in(String scope)
A scope to be associated with this descriptor object.
|
DescriptorBuilder |
localOnly()
This will cause the descriptorVisibility field of the returned
descriptor to return LOCAL
|
DescriptorBuilder |
named(String name)
The name for this descriptor object.
|
DescriptorBuilder |
ofRank(int rank)
The rank to be associated with this descriptor.
|
DescriptorBuilder |
proxy()
This will cause the isProxiable field of the returned
descriptor to return true (it will force this
descriptor to use proxies).
|
DescriptorBuilder |
proxy(boolean forceProxy)
This will cause the isProxiable field of the returned
descriptor to return the given value.
|
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).
|
DescriptorBuilder |
proxyForSameScope(boolean proxyForSameScope)
This will cause the isProxyForSameScope field of the returned
descriptor to return the given value.
|
DescriptorBuilder |
qualifiedBy(Annotation annotation)
A qualifier to be associated with this descriptor object.
|
DescriptorBuilder |
qualifiedBy(String annotation)
A qualifier to be associated with this descriptor object
|
DescriptorBuilder |
to(Class<?> contract)
A contract to be associated with this descriptor object.
|
DescriptorBuilder |
to(String contract)
A contract to be associated with this descriptor object.
|
DescriptorBuilder |
visibility(DescriptorVisibility visibility)
This will set the descriptorVisibility field of the returned
descriptor
|
DescriptorBuilder named(String name) throws IllegalArgumentException
name
- The name to be associated with this DescriptorIllegalArgumentException
- if there is more than one name on the predicateDescriptorBuilder to(Class<?> contract) throws IllegalArgumentException
contract
- A class that is annotated with Contract to
be associated with this DescriptorIllegalArgumentException
- on failuresDescriptorBuilder to(String contract) throws IllegalArgumentException
contract
- The fully qualified name of a class that is annotated with Contract.IllegalArgumentException
- on failuresDescriptorBuilder in(Class<? extends Annotation> scope) throws IllegalArgumentException
scope
- The class of the scope this descriptor is to have.IllegalArgumentException
- If in is called more than onceDescriptorBuilder in(String scope) throws IllegalArgumentException
scope
- The fully qualified class name of the scope this predicate is to have.IllegalArgumentException
- If in is called more than onceDescriptorBuilder qualifiedBy(Annotation annotation) throws IllegalArgumentException
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)
annotation
- The annotation to be associated with this descriptorIllegalArgumentException
- on failuresDescriptorBuilder qualifiedBy(String annotation) throws IllegalArgumentException
annotation
- The fully qualified class name of an annotation to be
associated with this descriptorIllegalArgumentException
- on failuresDescriptorBuilder has(String key, String value) throws IllegalArgumentException
key
- The key for the data to be associated with this descriptorvalue
- The value this key should take (single value metadata)IllegalArgumentException
DescriptorBuilder has(String key, List<String> values) throws IllegalArgumentException
key
- The key for the data to be associated with this descriptorvalues
- The values this key should take (single value metadata)IllegalArgumentException
DescriptorBuilder ofRank(int rank)
rank
- The rank to be associated with this descriptor.DescriptorBuilder proxy()
DescriptorBuilder proxy(boolean forceProxy)
forceProxy
- if true then this descriptor will be proxied,
if false then this descriptor will NOT be proxiedDescriptorBuilder proxyForSameScope()
DescriptorBuilder proxyForSameScope(boolean proxyForSameScope)
proxyForSameScope
- if true then this descriptor will be proxied
even when being injected into the same scope,
if false then this descriptor will NOT be proxied when injected
into a service of the same scopeDescriptorBuilder localOnly()
DescriptorBuilder visibility(DescriptorVisibility visibility)
visibility
- The non-null visibility that this descriptor should takeDescriptorBuilder andLoadWith(HK2Loader loader) throws IllegalArgumentException
loader
- The loader to use with this descriptorIllegalArgumentException
- if the HK2Loader is set non-null more than onceDescriptorBuilder analyzeWith(String serviceName)
ClassAnalyzer
service of the given nameserviceName
- the name of the ClassAnalyzer
service
that should be used to analyze this serviceDescriptorImpl build() throws IllegalArgumentException
IllegalArgumentException
- if the built descriptor is invalidFactoryDescriptors buildFactory() throws IllegalArgumentException
IllegalArgumentException
- if the built descriptor is invalidFactoryDescriptors buildFactory(String factoryScope) throws IllegalArgumentException
factoryScope
- The scope the factory service itself is in.IllegalArgumentException
- if the built descriptor is invalidFactoryDescriptors buildFactory(Class<? extends Annotation> factoryScope) throws IllegalArgumentException
factoryScope
- The scope the factory service itself is in. If this is null the
PerLookup scope will be usedIllegalArgumentException
- if the built descriptor is invalidCopyright © 2009-2017, Oracle and/or its affiliates. All Rights Reserved.