org.jooq.VisitContext 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
*
* 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 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.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* A context object for {@link QueryPart} traversal passed to registered
* {@link VisitListener}'s.
*
* This type is a {@link Scope} with whose lifecycle is shared with the parent
* rendering {@link Context} scope. It also shares the latter's {@link #data()}
* map.
*
* @author Lukas Eder
* @see VisitListener
*/
public interface VisitContext extends Scope {
/**
* The most recent clause that was encountered through
* {@link Context#start(Clause)}.
*/
@NotNull
Clause clause();
/**
* A path of clauses going through the visiting tree.
*
* This returns all previous clauses that were encountered through
* {@link Context#start(Clause)} and that haven't been removed yet through
* {@link Context#end(Clause)}. In other words, VisitContext
* contains a stack of clauses.
*/
@NotNull
Clause @NotNull [] clauses();
/**
* This is the same as calling {@link #clauses()}.length.
*/
int clausesLength();
/**
* The most recent {@link QueryPart} that was encountered through
* {@link Context#visit(QueryPart)}.
*/
@NotNull
QueryPart queryPart();
/**
* Replace the most recent {@link QueryPart} that was encountered through
* {@link Context#visit(QueryPart)}.
*
* This method can be called by {@link VisitListener} implementation
* methods, in particular by {@link VisitListener#visitStart(VisitContext)}.
*
* @param part The new QueryPart.
*/
void queryPart(QueryPart part);
/**
* A path of {@link QueryPart}s going through the visiting tree.
*
* This returns all previous QueryParts that were encountered
* through {@link Context#visit(QueryPart)}. In other words,
* VisitContext contains a stack of QueryParts.
*/
@NotNull
QueryPart @NotNull [] queryParts();
/**
* This is the same as calling {@link #queryParts()}.length.
*/
int queryPartsLength();
/**
* The underlying {@link RenderContext} or {@link BindContext} object.
*/
@NotNull
Context context();
/**
* The underlying {@link RenderContext} or null, if the
* underlying context is a {@link BindContext}.
*
* [#2694] [#2695] As of jOOQ 3.2, the {@link QueryPart} traversal SPI
* through {@link VisitListener} is only implemented for
* {@link RenderContext}. Hence, you may need to inline bind values if
* applicable.
*/
@Nullable
RenderContext renderContext();
/**
* The underlying {@link BindContext} or null, if the
* underlying context is a {@link RenderContext}.
*
* @throws UnsupportedOperationException [#2694] [#2695] As of jOOQ 3.2,
* this method is not yet implemented as {@link QueryPart}
* traversal SPI through {@link VisitListener} is only
* implemented for {@link RenderContext}
*/
@Nullable
BindContext bindContext() throws UnsupportedOperationException;
}