nl.topicus.jdbc.shaded.io.grpc.KnownLength Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation

JDBC Driver for Google Cloud Spanner

There is a newer version: 1.1.6

/*
 * Copyright 2014, Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *
 *    * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package nl.topicus.jdbc.shaded.io.grpc;

import java.nl.topicus.jdbc.shaded.io.IOException;

/**
 * An {@link java.nl.topicus.jdbc.shaded.io.InputStream} or alike whose total number of bytes that can be read is known
 * upfront.
 *
 * Usually it's a {@link java.nl.topicus.jdbc.shaded.io.InputStream} that also implements this interface, in which case
 * {@link java.nl.topicus.jdbc.shaded.io.InputStream#available()} has a stronger semantic by returning an accurate number
 * instead of an estimation.
 */
public interface KnownLength {
  /**
   * Returns the total number of bytes that can be read (or skipped over) from this object until all
   * bytes have been read out.
   */
  int available() throws IOException;
}