org.jooq.QueryPart Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
import java.io.Serializable;
/**
* The common base type for all objects that can be used for query composition.
*
* All QueryPart implementations can be cast to
* {@link QueryPartInternal} in order to access the internal API.
*
* @author Lukas Eder
*/
public interface QueryPart extends Serializable {
/**
* Render a SQL string of this QueryPart
*
* For improved debugging, this renders a SQL string of this
* QueryPart with inlined bind variables. If you wish to gain
* more control over the concrete SQL rendering of this
* QueryPart, use {@link DSLContext#renderContext()} to obtain a
* configurable render context for SQL rendering.
*
* @return A SQL string representation of this QueryPart
*/
@Override
String toString();
/**
* Check whether this QueryPart can be considered equal to
* another QueryPart.
*
* In general, QueryPart equality is defined in terms of
* {@link #toString()} equality. In other words, two query parts are
* considered equal if their rendered SQL (with inlined bind variables) is
* equal. This means that the two query parts do not necessarily have to be
* of the same type.
*
* Some QueryPart implementations may choose to override this
* behaviour for improved performance, as {@link #toString()} is an
* expensive operation, if called many times.
*
* @param object The other QueryPart
* @return Whether the two query parts are equal
*/
@Override
boolean equals(Object object);
/**
* Generate a hash code from this QueryPart.
*
* In general, QueryPart hash codes are the same as the hash
* codes generated from {@link #toString()}. This guarantees consistent
* behaviour with {@link #equals(Object)}
*
* Some QueryPart implementations may choose to override this
* behaviour for improved performance, as {@link #toString()} is an
* expensive operation, if called many times.
*
* @return The QueryPart hash code
*/
@Override
int hashCode();
}