org.glassfish.hk2.utilities.DescriptorBuilder Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.hk2.utilities;
import java.lang.annotation.Annotation;
import java.util.List;
import org.glassfish.hk2.api.DescriptorVisibility;
import org.glassfish.hk2.api.FactoryDescriptors;
import org.glassfish.hk2.api.HK2Loader;
/**
* This is an object that uses the Builder pattern
* in order to generate a Descriptor (for binding) or
* a Filter (for searching). It is intended
* to facilitate query strings of method calls
* that is simple to understand and read.
*
*/
public interface DescriptorBuilder {
/**
* 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 DescriptorBuilder 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 DescriptorBuilder to(Class contract) throws IllegalArgumentException;
/**
* A contract to be associated with this descriptor object.
*
* @param contract The fully qualified name of a class that is annotated with Contract.
* @return A DescriptorBuilder with the given name
* @throws IllegalArgumentException on failures
*/
public DescriptorBuilder to(String 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 DescriptorBuilder in(Class 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 fully qualified class name of the scope this predicate is to have.
* @return A DescriptorBuilder with the given scope
* @throws IllegalArgumentException If in is called more than once
*/
public DescriptorBuilder in(String 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 DescriptorBuilder qualifiedBy(Annotation annotation) throws IllegalArgumentException;
/**
* A qualifier to be associated with this descriptor object
*
* @param annotation The fully qualified class name of an annotation to be
* associated with this descriptor
* @return A DescriptorBuilder with the given annotation
* @throws IllegalArgumentException on failures
*/
public DescriptorBuilder qualifiedBy(String 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 DescriptorBuilder 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 DescriptorBuilder 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 DescriptorBuilder ofRank(int rank);
/**
* 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 DescriptorBuilder 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 DescriptorBuilder proxy(boolean forceProxy);
/**
* 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).
*
* @return A DescriptorBuilder with the proxyForSameScope field set to true
*/
public DescriptorBuilder proxyForSameScope();
/**
* This will cause the isProxyForSameScope field of the returned
* descriptor to return the given value.
*
* @param 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 scope
* @return A DescriptorBuilder with the proxyForSameScope field set to
* the given value
*/
public DescriptorBuilder proxyForSameScope(boolean proxyForSameScope);
/**
* 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 DescriptorBuilder 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 DescriptorBuilder visibility(DescriptorVisibility visibility);
/**
* 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 DescriptorBuilder 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 DescriptorBuilder analyzeWith(String serviceName);
/**
* Generates a descriptor that can be used in binding operations
*
* @return The descriptor that has been built up with this DescriptorBuilder
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public DescriptorImpl build() throws IllegalArgumentException;
/**
* 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
*
* @return The descriptor that has been built up with this DescriptorBuilder
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public FactoryDescriptors buildFactory() throws IllegalArgumentException;
/**
* 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
*
* @param factoryScope The scope the factory service itself is in.
* @return The descriptor that has been built up with this DescriptorBuilder
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public FactoryDescriptors buildFactory(String factoryScope) throws IllegalArgumentException;
/**
* 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
*
* @param factoryScope The scope the factory service itself is in. If this is null the
* PerLookup scope will be used
* @return The descriptor that has been built up with this DescriptorBuilder
* @throws IllegalArgumentException if the built descriptor is invalid
*/
public FactoryDescriptors buildFactory(Class factoryScope) throws IllegalArgumentException;
}