ASCIIOutputFile

java.lang.Object
- BasicIO.ASCIIOutputFile

```
public class ASCIIOutputFile
extends java.lang.Object
```
ASCIIOutputFile writes unformated text to a file suitable to be read by ASCIIDataFile. This text is broken into fields delimited by tabs and newline (End of Line) characters. Tabs are automatically inserted between fields on all write operations with the exception of writeLine and writeC. writeLine writes a newline character after writing the String parameter passed to it. writeC will write the character without field separators. Its purpose is for raw data output. If you wish to write a single char to a field use writeChar. If the data cannot be written to the file, either due to lack of space, or the file cannot be found, then the successful method will return false.

Version:

1.0 July 08, 2.0 (09/06/30)

Author:

A. Cheesman, David Hughes

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the file.
`java.io.File`	`getFile()` Returns the file being used
`void`	`newLine()` Writes a newline character to the file.
`boolean`	`successful()` Indicates whether or not the previous operation was successful.
`void`	`writeBoolean(boolean b)` Writes a boolean to the file
`void`	`writeByte(byte b)` Writes a byte to the file
`void`	`writeC(char c)` Writes a char to the file without any field seperators.
`void`	`writeChar(char c)` Writes a char to the file
`void`	`writeDouble(double d)` Writes a double to the file
`void`	`writeEOL()` Deprecated. Use newLine() instead.
`void`	`writeFloat(float f)` Writes a float to the file
`void`	`writeInt(int i)` Writes an int to the file
`void`	`writeLine(java.lang.String s)` Writes a String to the file with a newline character at the end of the String.
`void`	`writeLong(long l)` Writes a long to the file
`void`	`writeShort(short s)` Writes a short to the file
`void`	`writeString(java.lang.String s)` Writes a String to the file

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

- Constructor Detail
  - ASCIIOutputFile
```
public ASCIIOutputFile()
```
    Constructs an ASCIIOutputFile, prompting the user via Dialog Box for a file to write to.
  - ASCIIOutputFile
```
public ASCIIOutputFile(java.lang.String filename)
```
    Constructs an ASCIIOutputFile and tries to open a file with the path provided in the String.
    
    Parameters:
    
    filename - the name of the file to write to
  - ASCIIOutputFile
```
public ASCIIOutputFile(java.io.File file)
```
    Constructs an ASCIIOutputFile using the file provided.
    
    Parameters:
    
    file - the file to write to
- Method Detail
  - getFile
```
public java.io.File getFile()
```
    Returns the file being used
    
    Returns:
    
    the file being used.
  - successful
```
public boolean successful()
```
    Indicates whether or not the previous operation was successful. If it was a write operation, failure indicates the write was not possible (usually some I/O error). If it was a close operation, failure indicates inability to close the file. The file may subsequently be inaccessable.
    
    Returns:
    
    boolean: whether last operation was successful
  - close
```
public void close()
```
    Closes the file.
  - writeByte
```
public void writeByte(byte b)
```
    Writes a byte to the file
    
    Parameters:
    
    b - a byte to be written as a field to the file
  - writeChar
```
public void writeChar(char c)
```
    Writes a char to the file
    
    Parameters:
    
    c - char to be written as a field to the file
  - writeC
```
public void writeC(char c)
```
    Writes a char to the file without any field seperators.
    
    Parameters:
    
    c - a char to be written as a field to the file
  - writeDouble
```
public void writeDouble(double d)
```
    Writes a double to the file
    
    Parameters:
    
    d - a double to be written as a field to the file
  - writeFloat
```
public void writeFloat(float f)
```
    Writes a float to the file
    
    Parameters:
    
    f - a float to be written as a field to the file
  - writeInt
```
public void writeInt(int i)
```
    Writes an int to the file
    
    Parameters:
    
    i - an int to be written as a field to the file
  - writeShort
```
public void writeShort(short s)
```
    Writes a short to the file
    
    Parameters:
    
    s - short to be written as a field to the file
  - writeLong
```
public void writeLong(long l)
```
    Writes a long to the file
    
    Parameters:
    
    l - a long to be written as a field to the file
  - writeString
```
public void writeString(java.lang.String s)
```
    Writes a String to the file
    
    Parameters:
    
    s - a String to be written as a field to the file
  - writeBoolean
```
public void writeBoolean(boolean b)
```
    Writes a boolean to the file
    
    Parameters:
    
    b - a boolean to be written as a field to the file
  - writeLine
```
public void writeLine(java.lang.String s)
```
    Writes a String to the file with a newline character at the end of the String.
    
    Parameters:
    
    s - a String to be written to the file
  - writeEOL
```
public void writeEOL()
```
    Deprecated. Use newLine() instead.
    
    Writes a newline character to the file. The next write will begin on the next line.
  - newLine
```
public void newLine()
```
    Writes a newline character to the file. The next write eill begin on the next line.

Class ASCIIOutputFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ASCIIOutputFile

ASCIIOutputFile

ASCIIOutputFile

Method Detail

getFile

successful

close

writeByte

writeChar

writeC

writeDouble

writeFloat

writeInt

writeShort

writeLong

writeString

writeBoolean

writeLine

writeEOL

newLine