/*
* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
*
* 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 also distributed with certain software (including but not
* limited to OpenSSL) 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 included with MySQL.
*
* 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.result;
import java.util.
Iterator;
import com.mysql.cj.
Messages;
import com.mysql.cj.exceptions.
CJOperationNotSupportedException;
import com.mysql.cj.exceptions.
ExceptionFactory;
/**
* A list of {@link Row}s.
*/
public interface
RowList extends
Iterator<
Row> {
/**
* What's returned for the size of a row list when its size can not be
* determined.
*/
public static final int
RESULT_SET_SIZE_UNKNOWN = -1;
/**
* Optionally iterate backwards on the list.
*
* @return {@link Row}
*/
default
Row previous() {
throw
ExceptionFactory.
createException(
CJOperationNotSupportedException.class,
Messages.
getString("OperationNotSupportedException.0"));
}
/**
* Optionally retrieve Row at index <i>n</i>.
*
* Only works on non dynamic row lists.
*
* @param n
* row number
* @return {@link Row}
*/
default
Row get(int
n) {
throw
ExceptionFactory.
createException(
CJOperationNotSupportedException.class,
Messages.
getString("OperationNotSupportedException.0"));
}
/**
* Returns the current position.
*
* @return the current row number
*/
default int
getPosition() {
throw
ExceptionFactory.
createException(
CJOperationNotSupportedException.class,
Messages.
getString("OperationNotSupportedException.0"));
}
/**
* Only works on non dynamic row lists.
*
* @return the size of this row list
*/
default int
size() {
return
RESULT_SET_SIZE_UNKNOWN;
}
}