org.jooq.tools.jdbc.MockResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
There is a newer version: 3.19.11
/**
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.tools.jdbc;

import static org.jooq.impl.DSL.using;

import java.sql.Statement;

import org.jooq.AttachableInternal;
import org.jooq.Configuration;
import org.jooq.Record;
import org.jooq.Result;
import org.jooq.impl.DefaultConfiguration;

/**
 * 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, this may be
     * null. Note, that this can also be used to provide a result
     * for {@link Statement#getGeneratedKeys()}
     */
    public final Result data;

    /**
     * Create a new MockResult.
     * 
     * This is a convenience constructor creating a MockResult with exactly one record.
     *
     * @param data The single record in this result.
     */
    public MockResult(Record data) {
        this(1, result(data));
    }

    /**
     * Create a new MockResult.
     *
     * @param rows The number of affected rows
     * @param data The result data
     */
    public MockResult(int rows, Result data) {
        this.rows = rows;
        this.data = data;
    }

    private static final Result result(Record data) {
        Configuration configuration = data instanceof AttachableInternal
            ? ((AttachableInternal) data).configuration()
            : new DefaultConfiguration();

        Result result = using(configuration).newResult(data.fields());
        result.add(data);

        return result;
    }

    @Override
    public String toString() {
        return (data != null) ? data.toString() : ("" + rows);
    }
}