org.dbrain.binder.app.ServiceConfigurator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbrain-binder Show documentation

Guice-like facade to the unfriendly HK2 service locator.

There is a newer version: 0.13

/*
 * Copyright [2015] [Eric Poitras]
 *
 *     Licensed under the Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 */

package org.dbrain.binder.app;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

/**
 * Configure a single service description.
 */
public interface ServiceConfigurator extends Component {

    ServiceConfigurator toInstance( T instance );

    ServiceConfigurator providedBy( ServiceProvider provider );

    ServiceConfigurator disposedBy( ServiceDisposer disposer );

    ServiceConfigurator to( Type type );

    ServiceConfigurator qualifiedBy( Annotation quality );

    ServiceConfigurator qualifiedBy( Class quality );

    ServiceConfigurator qualifiedBy( Iterable quality );

    ServiceConfigurator named( String name );

    ServiceConfigurator in( Class scope );

    ServiceConfigurator useProxy();

    /**
     * A disposer that can fail miserably by throwing an exception.
     */
    @FunctionalInterface
    interface ServiceDisposer {

        /**
         * @return An instance of the service, or null.
         *
         * @throws Exception If the dispose failed.
         */
        void dispose( T instance ) throws Exception;

    }

    /**
     * A provider that can fail miserably by throwing an exception.
     */
    @FunctionalInterface
    interface ServiceProvider {

        /**
         * @return An instance of the service.
         *
         * @throws Exception If the creation failed.
         */
        T get() throws Exception;

    }
}