org.dbrain.binder.directory.ServiceKey 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.directory;

import org.dbrain.binder.system.directory.ServiceKeyBuilderImpl;

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

/**
 * Describe a service.
 */
public interface ServiceKey {

    static  Builder from( Class clazz ) {
        return new ServiceKeyBuilderImpl<>( clazz, clazz );
    }

    static  ServiceKey of( Class clazz ) {
        return from( clazz ).build();
    }

    static  ServiceKey of( Class clazz, String named ) {
        return from( clazz ).named( named ).build();
    }

    static  ServiceKey of( Class clazz, Class quality ) {
        return from( clazz ).qualifiedBy( quality ).build();
    }

    Type getServiceType();

    Class getServiceClass();

    Qualifiers getQualifiers();

    /**
     * Builder for service key.
     */
    interface Builder {

        Builder qualifiedBy( Annotation quality );

        Builder qualifiedBy( Class quality );

        Builder qualifiedBy( Iterable quality );

        Builder named( String name );

        ServiceKey build();

    }
}