io.streamthoughts.azkarra.api.components.ConditionalDescriptorRegistry Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2020 StreamThoughts.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 io.streamthoughts.azkarra.api.components;

import io.streamthoughts.azkarra.api.components.condition.ComponentConditionalContext;

import java.util.Collection;
import java.util.Optional;

/**
 * The main interface that defines methods to find registered {@link ComponentDescriptor} for
 * enable components.
 *
 * @see io.streamthoughts.azkarra.api.components.condition.Condition
 */
public interface ConditionalDescriptorRegistry {

    /**
     * Finds all {@link ComponentDescriptor} registered for the specified type.
     *
     * @param type      the component class.
     * @param        the component type.
     *
     * @return          the collection of {@link ComponentDescriptor}.
     */
     Collection> findAllDescriptorsByClass(final Class type,
                                                                     final ComponentConditionalContext context);

    /**
     * Finds all {@link ComponentDescriptor} registered for the specified type.
     *
     * @param type      the component class.
     * @param        the component type.
     *
     * @return          the collection of {@link ComponentDescriptor}.
     */
     Collection> findAllDescriptorsByClass(final Class type,
                                                                     final ComponentConditionalContext context,
                                                                     final Qualifier qualifier);

    /**
     * Finds all {@link ComponentDescriptor} registered for the specified alias.
     *
     * @param alias     the fully qualified class name or an alias of the component.
     * @param        the component type.
     *
     * @return          the collection of {@link ComponentDescriptor}.
     *
     */
     Collection> findAllDescriptorsByAlias(final String alias,
                                                                     final ComponentConditionalContext context);

    /**
     * Finds all {@link ComponentDescriptor} registered for the specified alias.
     *
     * @param alias     the fully qualified class name or an alias of the component.
     * @param        the component type.
     *
     * @return          the collection of {@link ComponentDescriptor}.
     *
     */
     Collection> findAllDescriptorsByAlias(final String alias,
                                                                     final ComponentConditionalContext context,
                                                                     final Qualifier qualifier);

    /**
     * Finds a {@link ComponentDescriptor} for the specified type.
     *
     * @param alias      the fully qualified class name or an alias of the component.
     * @param         the component type.
     *
     * @return           the optional {@link ComponentDescriptor} instance.
     *
     * @throws NoUniqueComponentException   if more than one component is registered for the given type.
     *
     */
     Optional> findDescriptorByAlias(final String alias,
                                                               final ComponentConditionalContext context) ;

    /**
     * Finds a {@link ComponentDescriptor} for the specified type and options.
     *
     * @param alias      the fully qualified class name or an alias of the component.
     * @param qualifier  the options used to qualified the component.
     * @param         the component type.
     *
     * @return           the optional {@link ComponentDescriptor} instance.
     * @throws NoUniqueComponentException   if more than one component is registered for the given type.
     */
     Optional> findDescriptorByAlias(final String alias,
                                                               final ComponentConditionalContext context,
                                                               final Qualifier qualifier);

    /**
     * Finds a {@link ComponentDescriptor} for the specified type.
     *
     * @param type       the component class.
     * @param         the component type.
     *
     * @return           the optional {@link ComponentDescriptor} instance.
     * @throws NoUniqueComponentException   if more than one component is registered for the given type.
     */
     Optional> findDescriptorByClass(final Class type,
                                                               final ComponentConditionalContext context);

    /**
     * Finds a {@link ComponentDescriptor} for the specified type and options.
     *
     * @param type       the fully qualified class name or an alias of the component.
     * @param qualifier  the options used to qualified the component.
     * @param         the component type.
     *
     * @return           the optional {@link ComponentDescriptor} instance.
     * @throws NoUniqueComponentException   if more than one component is registered for the given type.
     */
     Optional> findDescriptorByClass(final Class type,
                                                               final ComponentConditionalContext context,
                                                               final Qualifier qualifier);
}