com.julienviet.pgclient.PgResult Maven / Gradle / Ivy
/*
* Copyright (C) 2017 Julien Viet
*
* 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.
*
*/
package com.julienviet.pgclient;
import io.vertx.codegen.annotations.VertxGen;
import java.util.List;
/**
* Represents the result of an operation on database.
* @param
*/
@VertxGen
public interface PgResult extends Iterable {
/**
* Get the number of the affected rows in the operation to this PgResult.
*
* @return the count of affected rows.
*/
int updatedCount();
/**
* Get the names of columns in the PgResult.
*
* @return the list of names of columns.
*/
List columnsNames();
/**
* Get the number of rows in the PgResult.
*
* @return the count of rows.
*/
int size();
/**
* Get the iterator of the PgResult.
*
* @return the iterator.
*/
PgIterator iterator();
/**
* Return the next available result or {@code null}, e.g for a simple query that executed multiple queries or for
* a batch result.
*
* @return the next available result or {@code null} if none is available
*/
PgResult next();
}