org.elasticsearch.common.inject.spi.ElementVisitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.elasticsearch Show documentation
The newest version!
/*
 * Copyright (C) 2008 Google Inc.
 *
 * 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.elasticsearch.common.inject.spi;

import org.elasticsearch.common.inject.Binding;

/**
 * Visit elements.
 *
 * @param  any type to be returned by the visit method. Use {@link Void} with
 *            {@code return null} if no return type is needed.
 * @since 2.0
 */
public interface ElementVisitor {

    /**
     * Visit a mapping from a key (type and optional annotation) to the strategy for getting
     * instances of the type.
     */
     V visit(Binding binding);

    /**
     * Visit a registration of a scope annotation with the scope that implements it.
     */
    V visit(ScopeBinding binding);

    /**
     * Visit a registration of type converters for matching target types.
     */
    V visit(TypeConverterBinding binding);

    /**
     * Visit a request to inject the instance fields and methods of an instance.
     */
    V visit(InjectionRequest request);

    /**
     * Visit a request to inject the static fields and methods of type.
     */
    V visit(StaticInjectionRequest request);

    /**
     * Visit a lookup of the provider for a type.
     */
     V visit(ProviderLookup lookup);

    /**
     * Visit a lookup of the members injector.
     */
     V visit(MembersInjectorLookup lookup);

    /**
     * Visit an error message and the context in which it occurred.
     */
    V visit(Message message);

    /**
     * Visit a collection of configuration elements for a {@linkplain org.elasticsearch.common.inject.PrivateBinder
     * private binder}.
     */
    V visit(PrivateElements elements);

    /**
     * Visit an injectable type listener binding.
     */
    V visit(TypeListenerBinding binding);
}