Class ArrayFile

core/src/main/java/edu/mines/jtk/io/ArrayFile.java:37–829

An array file expands the capabilities of java.io.RandomAccessFile. Specifically, an array file has methods for efficiently reading and writing arrays of primitive values, such as ints and floats. Also, array files may be read or written with either BIG_ENDIAN or LITTLE_ENDIAN byte orders. <

 * @version 2006.08.05
 */
public class ArrayFile implements ArrayInput, ArrayOutput, Closeable {

  /**
   * Constructs an array file with specified name and access mode.
   * @param name the file name.
   * @param mode the access mode; "r", "rw", "rws", or "rwd".
   */
  public ArrayFile(String name, String mode) throws FileNotFoundException {
    this(name,mode,ByteOrder.BIG_ENDIAN,ByteOrder.BIG_ENDIAN);
  }

  /**
   * Constructs an array file with specified file and access mode.
   * @param file the file.
   * @param mode the access mode; "r", "rw", "rws", or "rwd".
   */
  public ArrayFile(File file, String mode) throws FileNotFoundException {
    this(file,mode,ByteOrder.BIG_ENDIAN,ByteOrder.BIG_ENDIAN);
  }

  /**
   * Constructs an array file with specified name, access mode, and byte orders.
   * @param name the file name.
   * @param mode the access mode; "r", "rw", "rws", or "rwd".
   * @param bor the byte order for reading.
   * @param bow the byte order for writing.
   */
  public ArrayFile(String name, String mode, ByteOrder bor, ByteOrder bow) 
    throws FileNotFoundException 
  {
    this(name!=null?new File(name):null,mode,bor,bow);
  }

  /**
   * Constructs an array file with specified file, access mode, and byte orders.
   * @param file the file.
   * @param mode the access mode; "r", "rw", "rws", or "rwd".
   * @param bor the byte order for reading.
   * @param bow the byte order for writing.
   */
  public ArrayFile(File file, String mode, ByteOrder bor, ByteOrder bow) 
    throws FileNotFoundException 
  {
    this(new RandomAccessFile(file,mode),bor,bow);
  }

  /**
   * Constructs an array file for a specified random-access file 
   * and byte orders.
   * @param raf the random-access file.
   * @param bor the byte order for reading.
   * @param bow the byte order for writing.
   */
  public ArrayFile(RandomAccessFile raf, ByteOrder bor, ByteOrder bow) {
    _raf = raf;
    _bor = bor;
    _bow = bow;
    _ai = new ArrayInputAdapter(raf,bor);