core-common/src/main/java/org/glassfish/jersey/internal/inject/CompositeBinder.java

/*
 * Copyright (c) 2017, 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.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.
 * <p>
 * {@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<Binder> 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<Binder> 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<Binder> 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[] {}));
    }
}