org.jooq.VisitListenerProvider Maven / Gradle / Ivy
/*
* 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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jooq.impl.DefaultVisitListenerProvider;
/**
* A provider for {@link VisitListener} instances.
*
* In order to facilitate the lifecycle management of VisitListener
* 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 VisitListener instance.
*
* Implementations are free to choose whether this method returns new
* instances at every call or whether the same instance is returned
* repetitively.
*
* A VisitListener shall be provided exactly once per
* Context traversal, i.e. per RenderContext or
* BindContext.
*
* @return A VisitListener instance.
* @see VisitListener
* @see VisitContext
* @see DefaultVisitListenerProvider
*/
VisitListener provide();
}