Interface ArrayInput

core/src/main/java/edu/mines/jtk/io/ArrayInput.java:27–248

An interface for reading arrays of primitive values from a binary stream. This interfaces extends the standard interface java.io.DataInput. It adds methods for reading arrays of primitive values. @author Dave Hale, Colorado School of Mines @version 2006.08.05

 * @version 2006.08.05
 */
public interface ArrayInput extends DataInput {

  // From DataInput
  public void readFully(byte[] b) throws IOException;
  public void readFully(byte[] b, int off, int len) throws IOException;
  public int skipBytes(int n) throws IOException;
  public boolean readBoolean() throws IOException;
  public byte readByte() throws IOException;
  public int readUnsignedByte() throws IOException;
  public short readShort() throws IOException;
  public int readUnsignedShort() throws IOException;
  public char readChar() throws IOException;
  public int readInt() throws IOException;
  public long readLong() throws IOException;
  public float readFloat() throws IOException;
  public double readDouble() throws IOException;
  public String readLine() throws IOException;
  public String readUTF() throws IOException;

  /**
   * Reads byte elements into a specified array.
   * @param v the array.
   * @param k the index of the first element to read.
   * @param n the number of elements to read.
   */
  public void readBytes(byte[] v, int k, int n) throws IOException;

  /**
   * Reads byte elements into a specified array.
   * The array length equals the number of elements to read.
   * @param v the array.
   */
  public void readBytes(byte[] v) throws IOException;

  /**
   * Reads byte elements into a specified array.
   * The array length equals the number of elements to read.
   * @param v the array.
   */
  public void readBytes(byte[][] v) throws IOException;

  /**
   * Reads byte elements into a specified array.
   * The array length equals the number of elements to read.
   * @param v the array.
   */
  public void readBytes(byte[][][] v) throws IOException;

  /**
   * Reads char elements into a specified array.
   * @param v the array.
   * @param k the index of the first element to read.
   * @param n the number of elements to read.
   */
  public void readChars(char[] v, int k, int n) throws IOException;

  /**
   * Reads char elements into a specified array.