org.glassfish.jersey.internal.inject.CompositeBinder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jersey-common Show documentation
Jersey core common packages
There is a newer version: 4.0.0-M1
/*
 * 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
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or 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 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.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;

/**
 * Utility class which is able to install several binders and register them as a whole.
 * 
 * {@code Binder} is able to recursively register all injection binding descriptions in all installed binders.
 *
 * @author Petr Bouda
 */
public class CompositeBinder extends AbstractBinder {

    private Collection installed = new ArrayList<>();

    /**
     * Creates a new {@code CompositeBinder} and adds the collection of binders as candidates to install.
     *
     * @param installed all binder ready to install.
     */
    private CompositeBinder(Collection installed) {
        this.installed = installed;
    }

    /**
     * Creates {@code CompositeBinder} with provided binders.
     *
     * @param binders provided binder to install as a collection.
     * @return composite binder.
     */
    public static AbstractBinder wrap(Collection binders) {
        return new CompositeBinder(binders);
    }

    /**
     * Creates {@code CompositeBinder} with provided binders.
     *
     * @param binders provided binder to install as an array.
     * @return composite binder.
     */
    public static AbstractBinder wrap(Binder... binders) {
        return new CompositeBinder(Arrays.asList(binders));
    }

    /**
     * Automatically installed all provided binders.
     */
    @Override
    public void configure() {
        install(installed.toArray(new AbstractBinder[] {}));
    }
}