org.glassfish.hk2.utilities.binding.BindingBuilderFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2015 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.binding;
import org.glassfish.hk2.api.DynamicConfiguration;
import org.glassfish.hk2.api.Factory;
import org.glassfish.hk2.api.HK2Loader;
import java.lang.annotation.Annotation;
/**
* HK2 injection binding utility methods.
*
* @author Tom Beerbower
* @author Marek Potociar (marek.potociar at oracle.com)
* @author Mason Taube (mason.taube at oracle.com)
*/
public class BindingBuilderFactory {
/**
* Add a binding represented by the binding builder to the HK2 dynamic configuration.
*
* @param builder binding builder.
* @param configuration HK2 dynamic configuration.
*/
public static void addBinding(BindingBuilder builder, DynamicConfiguration configuration) {
if (builder instanceof AbstractBindingBuilder) {
((AbstractBindingBuilder) builder).complete(configuration, null);
} else {
throw new IllegalArgumentException("Unknown binding builder type: " + builder.getClass().getName());
}
}
/**
* Add a binding represented by the binding builder to the HK2 dynamic configuration.
*
* @param builder binding builder.
* @param configuration HK2 dynamic configuration.
* @param defaultLoader default HK2 service loader that should be used to load the service class
* in case a custom loader has not been set.
*/
public static void addBinding(BindingBuilder builder, DynamicConfiguration configuration, HK2Loader defaultLoader) {
if (builder instanceof AbstractBindingBuilder) {
((AbstractBindingBuilder) builder).complete(configuration, defaultLoader);
} else {
throw new IllegalArgumentException("Unknown binding builder type: " + builder.getClass().getName());
}
}
/**
* Get a new factory class-based service binding builder.
*
* @param service type.
* @param factoryType service factory class.
* @param factoryScope factory scope.
* @return initialized binding builder.
*/
public static ServiceBindingBuilder newFactoryBinder(
Class> factoryType, Class factoryScope) {
return AbstractBindingBuilder.createFactoryBinder(factoryType, factoryScope);
}
/**
* Get a new factory class-based service binding builder.
*
* The factory itself is bound in a {@link org.glassfish.hk2.api.PerLookup per-lookup} scope.
*
* @param service type.
* @param factoryType service factory class.
* @return initialized binding builder.
*/
public static ServiceBindingBuilder newFactoryBinder(Class> factoryType) {
return AbstractBindingBuilder.createFactoryBinder(factoryType, null);
}
/**
* Get a new factory instance-based service binding builder.
*
* @param service type.
* @param factory service instance.
* @return initialized binding builder.
*/
public static ServiceBindingBuilder newFactoryBinder(Factory factory) {
return AbstractBindingBuilder.createFactoryBinder(factory);
}
/**
* Get a new class-based service binding builder.
*
* Does NOT bind the service type itself as a contract type.
*
* @param service type.
* @param serviceType service class.
* @return initialized binding builder.
*/
public static ServiceBindingBuilder newBinder(Class serviceType) {
return AbstractBindingBuilder.create(serviceType, false);
}
/**
* Get a new instance-based service binding builder. The binding is naturally
* considered to be a {@link javax.inject.Singleton singleton-scoped}.
*
* Does NOT bind the service type itself as a contract type.
*
* @param service type.
* @param service service instance.
* @return initialized binding builder.
*/
public static ScopedBindingBuilder newBinder(T service) {
return AbstractBindingBuilder.create(service);
}
}