network.oxalis.ng.commons.guice.OxalisModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oxalis-ng-commons Show documentation

Holds the stuff which is common for both inbound and outbound messages and should be shared between them.

There is a newer version: 1.0.0

/*
 * Copyright 2010-2018 Norwegian Agency for Public Management and eGovernment (Difi)
 *
 * Licensed under the EUPL, Version 1.1 or – as soon they
 * will be approved by the European Commission - subsequent
 * versions of the EUPL (the "Licence");
 *
 * You may not use this work except in compliance with the Licence.
 *
 * You may obtain a copy of the Licence at:
 *
 * https://joinup.ec.europa.eu/community/eupl/og_page/eupl
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the Licence is
 * distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */

package network.oxalis.ng.commons.guice;

import com.google.inject.AbstractModule;
import com.google.inject.Key;
import com.google.inject.name.Names;
import network.oxalis.ng.api.util.Type;
import network.oxalis.ng.commons.settings.SettingsBuilder;

/**
 * Specialized Guice module class with some extra methods heavily used by Oxalis.
 *
 * @author erlend
 * @since 4.0.1
 */
public abstract class OxalisModule extends AbstractModule {

    /**
     * Binds an implementation to an interface using the {@link Type} annotation as replacement
     * for {@link jakarta.inject.Named}.
     *
     * @param cls  Interface used for binding.
     * @param impl Implementation with {@link Type} annotation.
     */
    protected  void bindTyped(Class cls, Class impl) {
        bindTyped(cls, impl, impl.getAnnotation(Type.class).value());
    }

    /**
     * Binds an implementation to an interface with names.
     *
     * @param cls   Interface used for binding.
     * @param impl  Implementation of interface..
     * @param names Names used to identify
     */
    protected  void bindTyped(Class cls, Class impl, String... names) {
        for (String type : names)
            binder().skipSources(OxalisModule.class)
                    .bind(Key.get(cls, Names.named(type)))
                    .to(impl);
    }

    /**
     * Binds a configuration enum for use.
     *
     * @param cls Enum expressing configurations.
     */
    protected void bindSettings(Class cls) {
        SettingsBuilder.with(binder(), cls);
    }
}