org.datacleaner.guice.InjectorBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DataCleaner-desktop-api Show documentation
There is a newer version: 6.0.0
Show newest version
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.guice;

import java.util.ArrayList;
import java.util.List;

import javax.inject.Inject;

import org.datacleaner.connection.Datastore;
import org.datacleaner.windows.AnalysisJobBuilderWindow;

import com.google.inject.Binding;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.TypeLiteral;
import com.google.inject.util.Modules;

/**
 * Helper class for creating sub-injectors to the current injector.
 */
public final class InjectorBuilder {

    private final List> _inheritedTypeLiterals;
    private final AdHocModule _adHocModule;
    private final DCModule _parentModule;
    private final Injector _parentInjector;

    @Inject
    protected InjectorBuilder(final DCModule parentModule, final Injector injector) {
        _parentModule = parentModule;
        _parentInjector = injector;
        _adHocModule = new AdHocModule();
        _inheritedTypeLiterals = new ArrayList<>();
        inherit(AnalysisJobBuilderWindow.class);
        inherit(Datastore.class);
    }

    public InjectorBuilder with(final Class bindingClass, final Object providerOrInstance) {
        _adHocModule.bind(bindingClass, providerOrInstance);
        return this;
    }

    public InjectorBuilder with(final TypeLiteral bindingTypeLiteral, final Object providerOrInstance) {
        _adHocModule.bind(bindingTypeLiteral, providerOrInstance);
        return this;
    }

    public InjectorBuilder inherit(final Class bindingClass) {
        return inherit(Key.get(bindingClass));
    }

    public InjectorBuilder inherit(final Key key) {
        return inherit(key.getTypeLiteral());
    }

    public InjectorBuilder inherit(final TypeLiteral typeLiteral) {
        if (!_inheritedTypeLiterals.contains(typeLiteral)) {
            _inheritedTypeLiterals.add(typeLiteral);
        }
        return this;
    }

    /**
     * Gets an instance of a particular type
     *
     * @param 
     * @param type
     * @return
     */
    public  E getInstance(final Class type) {
        return createInjector().getInstance(type);
    }

    /**
     * Creates an {@link Injector} which in turn can be used to get instances of
     * various types.
     *
     * Note the the {@link #getInstance(Class)} method is preferred, if only a
     * single injection is to be made.
     *
     * @return a Guice injector
     */
    public Injector createInjector() {
        for (final TypeLiteral typeLiteral : _inheritedTypeLiterals) {
            final Key key = Key.get(typeLiteral);
            final Binding binding = _parentInjector.getExistingBinding(key);
            if (binding != null) {
                if (!_adHocModule.hasBindingFor(typeLiteral)) {
                    // Bind entry if not already bound in adhoc module!!!
                    _adHocModule.bind(typeLiteral, binding.getProvider());
                }
            }
        }

        final Module module = Modules.override(_parentModule).with(_adHocModule);
        return Guice.createInjector(module);
    }
}