org.jooq.TableOnConditionStep 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
* Apache-2.0 license 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.jetbrains.annotations.*;
import org.jooq.impl.DSL;
/**
* An intermediate (optional) type for the construction of a JOIN
* clause, where the join criteria is added using an ON clause
* (with a {@link Condition}. This type can be used as a convenience type for
* connecting more conditions.
*
*
Referencing XYZ*Step types directly from client code
*
* It is usually not recommended to reference any XYZ*Step types
* directly from client code, or assign them to local variables. When writing
* dynamic SQL, creating a statement's components dynamically, and passing them
* to the DSL API statically is usually a better choice. See the manual's
* section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.
*
* Drawbacks of referencing the XYZ*Step types directly:
*
* - They're operating on mutable implementations (as of jOOQ 3.x)
* - They're less composable and not easy to get right when dynamic SQL gets
* complex
* - They're less readable
* - They might have binary incompatible changes between minor releases
*
*
* @author Lukas Eder
*/
public interface TableOnConditionStep extends Table {
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep and(Condition condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep and(Field condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(SQL)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep and(SQL sql);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep and(String sql);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, Object...)
* @see DSL#sql(String, Object...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep and(String sql, Object... bindings);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, QueryPart...)
* @see DSL#sql(String, QueryPart...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep and(String sql, QueryPart... parts);
/**
* Combine the currently assembled conditions with a negated other one using
* the {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep andNot(Condition condition);
/**
* Combine the currently assembled conditions with a negated other one using
* the {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep andNot(Field condition);
/**
* Combine the currently assembled conditions with an EXISTS
* clause using the {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep andExists(Select select);
/**
* Combine the currently assembled conditions with a NOT EXISTS
* clause using the {@link Operator#AND} operator.
*/
@NotNull
@Support
TableOnConditionStep andNotExists(Select select);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep or(Condition condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep or(Field condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(SQL)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep or(SQL sql);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep or(String sql);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, Object...)
* @see DSL#sql(String, Object...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep or(String sql, Object... bindings);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator.
*
* NOTE: When inserting plain SQL into jOOQ objects, you must
* guarantee syntax integrity. You may also create the possibility of
* malicious SQL injection. Be sure to properly use bind variables and/or
* escape literals when concatenated into SQL clauses!
*
* @see DSL#condition(String, QueryPart...)
* @see DSL#sql(String, QueryPart...)
* @see SQL
*/
@NotNull
@Support
@PlainSQL
TableOnConditionStep or(String sql, QueryPart... parts);
/**
* Combine the currently assembled conditions with a negated other one using
* the {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep orNot(Condition condition);
/**
* Combine the currently assembled conditions with a negated other one using
* the {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep orNot(Field condition);
/**
* Combine the currently assembled conditions with an EXISTS
* clause using the {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep orExists(Select select);
/**
* Combine the currently assembled conditions with a NOT EXISTS
* clause using the {@link Operator#OR} operator.
*/
@NotNull
@Support
TableOnConditionStep orNotExists(Select select);
}