org.jooq.tools.jdbc.MockResult 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 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.tools.jdbc;
import java.sql.SQLException;
import java.sql.Statement;
import org.jooq.DSLContext;
import org.jooq.Record;
import org.jooq.Result;
/**
* A mock result.
*
* This type is used to wrap unified results of DDL and DML query executions.
* JDBC execution results can be summarised to two properties:
*
* - {@link Statement#getUpdateCount()}: The number of affected rows
* - {@link Statement#getResultSet()}: The result set
*
*
* See {@link MockDataProvider#execute(MockExecuteContext)} for more details
*
* @author Lukas Eder
* @see MockDataProvider
*/
public class MockResult {
/**
* The number of affected rows for this execution result.
*
* This number corresponds to the value of
* {@link Statement#getUpdateCount()}. The following values are possible:
*
* - Positive numbers: the number of affected rows by a given query
* execution
* - 0: no rows were affected by a given query execution
* - -1: the row count is not applicable
*
*/
public final int rows;
/**
* The result data associated with this execution result.
*
* This object describes the result data (including meta data).
*
* If the given query execution did not provide any results (as in
* {@link Statement#execute(String)} == false), this may be
* null. This is not the same as producing an empty
* result, which can only be modelled by an empty {@link Result}, containing
* column information but no rows.
*
* Note, that this can also be used to provide a result for
* {@link Statement#getGeneratedKeys()}
*/
public final Result data;
/**
* The exception associated with this execution result.
*
* If present, the current result produces an exception.
*/
public final SQLException exception;
/**
* Create a new MockResult.
*
* This is a convenience constructor calling
* MockResult(-1, null).
*
* @see MockDataProvider MockDataProvider for details
*/
public MockResult() {
this(-1, null);
}
/**
* Create a new MockResult.
*
* This is a convenience constructor calling
* MockResult(rows, null).
*
* @see MockDataProvider MockDataProvider for details
*/
public MockResult(int rows) {
this(rows, null);
}
/**
* Create a new MockResult.
*
* This is a convenience constructor creating a MockResult with
* exactly one record.
*
* @param data The single record in this result. Record instances can be
* obtained from queries, instantiated from generated record
* classes, or created using
* {@link DSLContext#newRecord(org.jooq.Field...)} and other
* overloads.
* @see MockDataProvider MockDataProvider for details
*/
public MockResult(Record data) {
this(1, Mock.result(data));
}
/**
* Create a new MockResult.
*
* @param rows The number of affected rows
* @param data The result data. Result instances can be obtained from
* queries, or created using
* {@link DSLContext#newResult(org.jooq.Field...)} and other
* overloads.
* @see MockDataProvider MockDataProvider for details
*/
public MockResult(int rows, Result data) {
this.rows = rows;
this.data = data;
this.exception = null;
}
public MockResult(SQLException exception) {
this.rows = -1;
this.data = null;
this.exception = exception;
}
@Override
public String toString() {
return (exception != null)
? "Exception : " + exception.getMessage()
: (data != null)
? data.toString()
: ("" + rows);
}
}