org.glassfish.hk2.utilities.ActiveDescriptorBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.hk2.utilities;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.List;
import org.glassfish.hk2.api.DescriptorVisibility;
import org.glassfish.hk2.api.HK2Loader;
/**
* The active descriptor build is for building up a
* non-reified ActiveDescriptor. Non-reified active descriptors
* are useful because upon bind the system will not do further
* analysis of the associated class file, assuming instead that
* all the information from the ActiveDescriptor is what the
* user intended. This can be used to supply qualifiers that are
* not marked with {@link jakarta.inject.Qualifier} or contracts that are not
* marked with {@link org.jvnet.hk2.annotations.Contract}. An unreified ActiveDescriptor given
* to a bind method need not implement the create or destroy method,
* as they are automatically created and destroyed by the system.
*
* @author jwells
*
*/
public 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.
*
* @param name The name to be associated with this Descriptor
* @return A DescriptorBuilder with the given name
* @throws IllegalArgumentException if there is more than one name on the predicate
*/
public ActiveDescriptorBuilder named(String name) throws IllegalArgumentException;
/**
* A contract to be associated with this descriptor object.
*
* @param contract A class that is annotated with Contract to
* be associated with this Descriptor
* @return A DescriptorBuilder with the given name
* @throws IllegalArgumentException on failures
*/
public ActiveDescriptorBuilder to(Type contract) throws IllegalArgumentException;
/**
* 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.
*
* @param scope The class of the scope this descriptor is to have.
* @return A DescriptorBuilder with the given scope
* @throws IllegalArgumentException If in is called more than once
*/
public ActiveDescriptorBuilder in(Annotation scope) throws IllegalArgumentException;
/**
* 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.
*
* @param scope The class of the scope this descriptor is to have.
* @return A DescriptorBuilder with the given scope
* @throws IllegalArgumentException If in is called more than once
*/
public ActiveDescriptorBuilder in(Class scope) throws IllegalArgumentException;
/**
* A qualifier to be associated with this descriptor object
*
* @param annotation The annotation to be associated with this descriptor
* @return A DescriptorBuilder with the given annotation
* @throws IllegalArgumentException on failures
*/
public ActiveDescriptorBuilder qualifiedBy(Annotation annotation) throws IllegalArgumentException;
/**
* An instance of data to be associated with this descriptor
*
* @param key The key for the data to be associated with this descriptor
* @param value The value this key should take (single value metadata)
* @return A DescriptorBuilder with the given metadata
* @throws IllegalArgumentException
*/
public ActiveDescriptorBuilder has(String key, String value) throws IllegalArgumentException;
/**
* An instance of data to be associated with this descriptor
*
* @param key The key for the data to be associated with this descriptor
* @param values The values this key should take (single value metadata)
* @return A DescriptorBuilder with the given metadata
* @throws IllegalArgumentException
*/
public ActiveDescriptorBuilder has(String key, List values) throws IllegalArgumentException;
/**
* The rank to be associated with this descriptor. The last rank
* bound wins
*
* @param rank The rank to be associated with this descriptor.
* @return A DescriptorBuilder with the given rank
*/
public ActiveDescriptorBuilder ofRank(int rank);
/**
* This will cause the descriptorVisibility field of the returned
* descriptor to return LOCAL
*
* @return A DescriptorBuilder with the descriptorVisibility
* field to be set to LOCAL
*/
public ActiveDescriptorBuilder localOnly();
/**
* This will set the descriptorVisibility field of the returned
* descriptor
*
* @param visibility The non-null visibility that this descriptor should take
* @return A DescriptorBuilder with the descriptorVisibility field
* set to the input value
*/
public ActiveDescriptorBuilder visibility(DescriptorVisibility visibility);
/**
* This will cause the isProxiable field of the returned
* descriptor to return true (it will force this
* descriptor to use proxies).
*
* @return A DescriptorBuilder with the proxiable field set to true
*/
public ActiveDescriptorBuilder proxy();
/**
* This will cause the isProxiable field of the returned
* descriptor to return the given value.
*
* @param forceProxy if true then this descriptor will be proxied,
* if false then this descriptor will NOT be proxied
* @return A DescriptorBuilder with the proxiable field set to
* the given value
*/
public ActiveDescriptorBuilder proxy(boolean forceProxy);
/**
* 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).
*
* @return A DescriptorBuilder with the proxyForSameScope field set to true
*/
public ActiveDescriptorBuilder proxyForSameScope();
/**
* This will cause the isProxyForSameScope field of the returned
* descriptor to return the given value.
*
* @param 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
* @return A DescriptorBuilder with the proxyForSameScope field set to
* the given value
*/
public ActiveDescriptorBuilder proxyForSameScope(boolean forceProxyForSameScope);
/**
* Call this if this descriptor should be loaded with the given HK2Loader
*
* @param loader The loader to use with this descriptor
* @return A DescriptorBuilder with the given HK2Loader
* @throws IllegalArgumentException if the HK2Loader is set non-null more than once
*/
public ActiveDescriptorBuilder andLoadWith(HK2Loader loader) throws IllegalArgumentException;
/**
* Call this if the descriptor should be analyzed with the
* {@link org.glassfish.hk2.api.ClassAnalyzer} service of the given name
*
* @param serviceName the name of the {@link org.glassfish.hk2.api.ClassAnalyzer} service
* that should be used to analyze this service
* @return A DescriptorBuilder with the given analysis service
*/
public ActiveDescriptorBuilder analyzeWith(String serviceName);
/**
* 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
*
* @param t The non-null ParameterizedType describing the implementation
* @return A DescriptorBuilder with the given implementationType
*/
public ActiveDescriptorBuilder asType(Type t);
/**
* Generates a descriptor that can be used in binding operations
*
* @return The descriptor that has been built up
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public AbstractActiveDescriptor build() throws IllegalArgumentException;
/**
* Generates a descriptor that can be used in binding operations that
* describes a factorys provide method
*
* @return The descriptor that has been built up, of type PROVIDE_METHOD
* @throws IllegalArgumentException if the built descriptor is invalid
* @deprecated Use buildProvideMethod instead
*/
@Deprecated
public AbstractActiveDescriptor buildFactory() throws IllegalArgumentException;
/**
* Generates a descriptor that can be used in binding operations that
* describes a factorys provide method
*
* @return The descriptor that has been built up, of type PROVIDE_METHOD
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public AbstractActiveDescriptor buildProvideMethod() throws IllegalArgumentException;
}