com.mysql.cj.protocol.ResultBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-j Show documentation

JDBC Type 4 driver for MySQL.

The newest version!

/*
 * Copyright (c) 2019, 2024, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2.0, as published by
 * the Free Software Foundation.
 *
 * This program is designed to work with certain software that is licensed under separate terms, as designated in a particular file or component or in
 * included license documentation. The authors of MySQL hereby grant you an additional permission to link the program and your derivative works with the
 * separately licensed software that they have either included with the program or referenced in the documentation.
 *
 * Without limiting anything contained in the foregoing, this file, which is part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
 * version 1.0, a copy of which can be found at http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

package com.mysql.cj.protocol;

/**
 * Classes implementing this interface are responsible for building result of specific type from incoming ProtocolEntity objects.
 *
 * @param 
 *            result type
 */
public interface ResultBuilder {

    /**
     * Add ProtocolEntity.
     *
     * @param entity
     *            {@link ProtocolEntity} object
     * @return true - if this builder is ready for building the result;
     *         false - if another ProtocolEntity is required
     */
    boolean addProtocolEntity(ProtocolEntity entity);

    /**
     * Build the result using already added protocol instances.
     *
     * @return {@link T} instance
     */
    T build();

}