/*
 * 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jooq.impl.DefaultVisitListenerProvider;

import org.jetbrains.annotations.NotNull;

/**
 * A provider for {@link VisitListener} instances.
 * <p>
 * In order to facilitate the lifecycle management of <code>VisitListener</code>
 * instances that are provided to a jOOQ {@link Configuration}, clients can
 * implement this API. To jOOQ, it is thus irrelevant, if execute listeners are
 * stateful or stateless, local to a single record or record manipulation, or
 * global to an application.
 *
 * @author Lukas Eder
 * @see VisitListener
 * @see Configuration
 */
@FunctionalInterface
public interface VisitListenerProvider {

    /**
     * Provide a <code>VisitListener</code> instance.
     * <p>
     * Implementations are free to choose whether this method returns new
     * instances at every call or whether the same instance is returned
     * repetitively.
     * <p>
     * A <code>VisitListener</code> shall be provided exactly once per
     * <code>Context</code> traversal, i.e. per <code>RenderContext</code> or
     * <code>BindContext</code>.
     *
     * @return A <code>VisitListener</code> instance.
     * @see VisitListener
     * @see VisitContext
     * @see DefaultVisitListenerProvider
     */
    @NotNull
    VisitListener provide();
}
