BinaryDataFile

java.lang.Object
- BasicIO.BinaryDataFile

```
public class BinaryDataFile
extends java.lang.Object
```
BinaryDataFile reads data from binary files. There are various read methods in this class: readInt, readDouble, etc. Each of these methods reads a number of bytes appropriate for a value or a serialized Object, returning the bytes in the file as they would represent the primitive type or object.

Version:

1.0 July 08

Author:

A. Cheesman

Constructor Summary

Constructors
Constructor and Description
`BinaryDataFile()` Constructs an BinaryDataFile, prompting the user via Dialog Box for a file to read from.
`BinaryDataFile(java.io.File file)` Constructs an BinaryDataFile using the file provided.
`BinaryDataFile(java.lang.String filename)` Constructs an BinaryDataFile and tries to open a file with the path provided in the String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the file
`java.io.File`	`getFile()` Returns the file being used
`boolean`	`isDataError()` Returns true if last operation failed because of a data error, meaning the data did not conform to format.
`boolean`	`isEOF()` Returns true if the last operation failed because of EOF, false otherwise.
`boolean`	`readBoolean()` Reads the next bytes in the file and returns them as a boolean.
`byte`	`readByte()` Reads the next byte in the file and returns it as a byte.
`char`	`readChar()` Reads the next bytes in the file and returns them as a char.
`double`	`readDouble()` Reads the next bytes in the file and returns them as a double.
`float`	`readFloat()` Reads the next bytes in the file and returns them as a float.
`int`	`readInt()` Reads the next bytes in the file and returns them as a int.
`long`	`readLong()` Reads the next bytes in the file and returns them as a long.
`java.lang.Object`	`readObject()` Reads the next bytes in the file and returns them as an Object.
`short`	`readShort()` Reads the next bytes in the file and returns them as a short.
`java.lang.String`	`readString()` Reads the next bytes in the file and returns them as a String.
`boolean`	`successful()` Returns true if the last operation was succesfull, false otherwise.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BinaryDataFile
```
public BinaryDataFile()
```
    Constructs an BinaryDataFile, prompting the user via Dialog Box for a file to read from.
  - BinaryDataFile
```
public BinaryDataFile(java.lang.String filename)
```
    Constructs an BinaryDataFile and tries to open a file with the path provided in the String.
    
    Parameters:
    
    filename - the name of the file to read from
  - BinaryDataFile
```
public BinaryDataFile(java.io.File file)
```
    Constructs an BinaryDataFile using the file provided.
    
    Parameters:
    
    file - the file to read from
- Method Detail
  - getFile
```
public java.io.File getFile()
```
    Returns the file being used
    
    Returns:
    
    the file being used.
  - successful
```
public boolean successful()
```
    Returns true if the last operation was succesfull, false otherwise.
    An operation can fail for several reasons:
    - a read operation was peformed and it is the end of the file. isEOF will return true in this case.
    - a field can not be converted into the specified type, results. isDataError will return true in this case.
    
    Returns:
    
    True if last operation was succesfull, false otherwise.
    
    See Also:
    
    isEOF(), isDataError()
  - isEOF
```
public boolean isEOF()
```
    Returns true if the last operation failed because of EOF, false otherwise.
    
    Returns:
    
    True if the last operation failed because of EOF, false otherwise.
  - isDataError
```
public boolean isDataError()
```
    Returns true if last operation failed because of a data error, meaning the data did not conform to format.
    
    Returns:
    
    True if there was a data error in the last operation, false otherwise.
  - close
```
public void close()
```
    Closes the file
  - readObject
```
public java.lang.Object readObject()
```
    Reads the next bytes in the file and returns them as an Object.
    
    Returns:
    
    an Object constructed from the bytes in the file
  - readByte
```
public byte readByte()
```
    Reads the next byte in the file and returns it as a byte.
    
    Returns:
    
    a byte constructed from the bytes in the file
  - readChar
```
public char readChar()
```
    Reads the next bytes in the file and returns them as a char.
    
    Returns:
    
    a char constructed from the bytes in the file
  - readDouble
```
public double readDouble()
```
    Reads the next bytes in the file and returns them as a double.
    
    Returns:
    
    a double constructed from the bytes in the file
  - readFloat
```
public float readFloat()
```
    Reads the next bytes in the file and returns them as a float.
    
    Returns:
    
    a float constructed from the bytes in the file
  - readInt
```
public int readInt()
```
    Reads the next bytes in the file and returns them as a int.
    
    Returns:
    
    a int constructed from the bytes in the file
  - readShort
```
public short readShort()
```
    Reads the next bytes in the file and returns them as a short.
    
    Returns:
    
    a short constructed from the bytes in the file
  - readLong
```
public long readLong()
```
    Reads the next bytes in the file and returns them as a long.
    
    Returns:
    
    a long constructed from the bytes in the file
  - readString
```
public java.lang.String readString()
```
    Reads the next bytes in the file and returns them as a String.
    
    Returns:
    
    a String constructed from the bytes in the file
  - readBoolean
```
public boolean readBoolean()
```
    Reads the next bytes in the file and returns them as a boolean.
    
    Returns:
    
    a boolean constructed from the bytes in the file

Class BinaryDataFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryDataFile

BinaryDataFile

BinaryDataFile

Method Detail

getFile

successful

isEOF

isDataError

close

readObject

readByte

readChar

readDouble

readFloat

readInt

readShort

readLong

readString

readBoolean