org.glassfish.jersey.internal.inject.Bindings Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017 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
* http://glassfish.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.jersey.internal.inject;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.function.Supplier;
import javax.ws.rs.core.GenericType;
import org.glassfish.jersey.internal.util.ReflectionHelper;
/**
* Utility class to create a new injection binding descriptions for arbitrary Java beans.
*
* @author Petr Bouda (petr.bouda at oracle.com)
*/
public final class Bindings {
private Bindings() {
throw new AssertionError("Utility class instantiation forbidden.");
}
/**
* Start building a new class-based service binding.
*
* Does NOT service the service type itself as a contract type.
*
* @param service type.
* @param serviceType service class.
* @return initialized binding builder.
*/
public static ClassBinding service(Class serviceType) {
return new ClassBinding<>(serviceType);
}
/**
* Start building a new class-based service binding.
*
* Binds the service type itself as a contract type.
*
* @param service type.
* @param serviceType service class.
* @return initialized binding builder.
*/
public static ClassBinding serviceAsContract(Class serviceType) {
return new ClassBinding<>(serviceType).to(serviceType);
}
/**
* Start building a new generic type-based service binding.
*
* Binds the generic service type itself as a contract type.
*
* @param service type.
* @param serviceType generic service type information.
* @return initialized binding builder.
*/
@SuppressWarnings("unchecked")
public static ClassBinding service(GenericType serviceType) {
return (ClassBinding) new ClassBinding<>(serviceType.getRawType()).asType(serviceType.getType());
}
/**
* Start building a new generic type-based service binding.
*
* Binds the generic service type itself as a contract type.
*
* @param service type.
* @param serviceType generic service type information.
* @return initialized binding builder.
*/
@SuppressWarnings("unchecked")
public static ClassBinding serviceAsContract(GenericType serviceType) {
return (ClassBinding) new ClassBinding<>(serviceType.getRawType())
.asType(serviceType.getType())
.to(serviceType.getType());
}
/**
* Start building a new generic type-based service binding.
*
* Binds the generic service type itself as a contract type.
*
* @param service type.
* @param serviceType generic service type information.
* @return initialized binding builder.
*/
@SuppressWarnings("unchecked")
public static ClassBinding serviceAsContract(Type serviceType) {
return new ClassBinding<>((Class) ReflectionHelper.getRawClass(serviceType))
.asType(serviceType)
.to(serviceType);
}
/**
* Start building a new instance-based service binding. The binding is naturally
* considered to be a {@link javax.inject.Singleton singleton-scoped}.
*
* Does NOT service the service type itself as a contract type.
*
* @param service type.
* @param service service instance.
* @return initialized binding builder.
*/
public static InstanceBinding service(T service) {
return new InstanceBinding<>(service);
}
/**
* Start building a new instance-based service binding. The binding is naturally
* considered to be a {@link javax.inject.Singleton singleton-scoped}.
*
* Binds the generic service type itself as a contract type.
*
* @param service type.
* @param service service instance.
* @return initialized binding builder.
*/
public static InstanceBinding serviceAsContract(T service) {
return new InstanceBinding<>(service, service.getClass());
}
/**
* Start building a new supplier class-based service binding.
*
* @param service type.
* @param supplierType service supplier class.
* @param supplierScope factory scope.
* @return initialized binding builder.
*/
public static SupplierClassBinding supplier(
Class extends Supplier> supplierType, Class extends Annotation> supplierScope) {
return new SupplierClassBinding<>(supplierType, supplierScope);
}
/**
* Start building a new supplier class-based service binding.
*
* The supplier itself is bound in a per-lookup scope.
*
* @param service type.
* @param supplierType service supplier class.
* @return initialized binding builder.
*/
public static SupplierClassBinding supplier(Class extends Supplier> supplierType) {
return new SupplierClassBinding<>(supplierType, null);
}
/**
* Start building a new supplier instance-based service binding.
*
* @param service type.
* @param supplier service instance.
* @return initialized binding builder.
*/
public static SupplierInstanceBinding supplier(Supplier supplier) {
return new SupplierInstanceBinding<>(supplier);
}
/**
* Start building a new injection resolver binding. The injection resolver is naturally
* considered to be a {@link javax.inject.Singleton singleton-scoped}.
*
* There is no need to provide any additional information. Other method on {@link Binding}
* will be ignored.
*
* @param type of the injection resolver.
* @param resolver injection resolver instance.
* @return initialized binding builder.
*/
public static InjectionResolverBinding injectionResolver(T resolver) {
return new InjectionResolverBinding<>(resolver);
}
}