PhantomOutputFile (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomOutputFile

```
public class PhantomOutputFile
extends Object
```
This class is used for creating and writing to files that are stored using Phantom Hurricane in OEM ASCII or Ansi character set.

Field Summary
Fields
Modifier and Type Field and Description
static byte[] isoNewLine
The New Line separator bytes for ISO character encoding.
static String newLine
The New Line separator.

Fields
Modifier and Type	Field and Description
`static byte[]`	`isoNewLine` The New Line separator bytes for ISO character encoding.
`static String`	`newLine` The New Line separator.

Constructor Summary

Constructors
Constructor and Description
`PhantomOutputFile()` Creates a in-memory byte array output stream where the contents can be retrieved by means of getByteArrayOutputStream() or getByteArray() methods.
`PhantomOutputFile(File file)` Creates the specified file for write.
`PhantomOutputFile(OutputStream out)` Creates an instance for the output stream.
`PhantomOutputFile(String fileName)` Creates the specified file for write.
`PhantomOutputFile(String fileName, PhantomFile openFile)` Creates the specified file for write.
`PhantomOutputFile(String fileName, String previousFile)` Creates the specified file for write.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close stream and file
`byte[]`	`getByteArray()` Gets the written data as a byte array when the file refers to an in-memory file.
`ByteArrayOutputStream`	`getByteArrayOutputStream()` Gets the byte array output stream instance.
`DataOutputStream`	`getDataOutputStream()` Gets the data output stream instance.
`FileOutputStream`	`getFileOutputStream()` Gets the file output stream instance.
`OutputStream`	`getOutputStream()` Gets the file output stream instance.
`boolean`	`isNetPhantom5File()` Checks if the file is used to write data for NetPhantom 5 or not.
`void`	`setCodePages(String ansiCP, String oemCP)` Sets the Ansi and OEM code pages.
`void`	`setNetPhantom5(boolean isNetPhantom5)` Sets the NetPhantom 5 flag.
`void`	`writeAnsiString(String s)` Writes a string to its length using the Ansi character set.
`void`	`writeAnsiStringNullTerminated(String s, int length)` Writes an Ansi string padded to the specified length with the zero padding character.
`void`	`writeAnsiStringPadded(String s, int length, char pad)` Writes an Ansi string padded to the specified length with the padding character.
`void`	`writeAnsiStrings(Collection<String> strings)` Converts an array of unicode strings to Ansi bytes and writes them to file using environment dependent line separator.
`void`	`writeBoolean(boolean b)` Write a number of zero'ed bytes.
`void`	`writeByte(byte d)` Write a byte to the file.
`void`	`writeByte(int d)` Write a byte to the file.
`void`	`writeBytes(byte[] d)` Write a byte array to the file.
`void`	`writeBytes(byte[] d, int offset, int length)` Write a byte array to the file.
`void`	`writeIntelDouble(double value)` Writes a double value from the file.
`void`	`writeIntelLong(int v)` Writes an Intel formatted Long (32 bit value).
`void`	`writeIntelShort(int v)` Writes an Intel formatted Short (16 bit signed value).
`void`	`writeIntelUShort(int v)` Writes an Intel formatted UShort (16 bit unsigned value).
`void`	`writeISOLine(String line)` Writes a string as a line in a file encoded in ISO 8859-1 character set.
`void`	`writeLine(byte[] line)` Writes an array of bytes to file and append line separator.
`void`	`writeOEMString(String s)` Writes a string to its length using the OEM (ASCII) character set.
`void`	`writeOEMStringNullTerminated(String s, int length)` Writes an OEM string padded to the specified length with the zero padding character.
`void`	`writeOEMStringPadded(String s, int length, char pad)` Writes a string padded to the specified length with the padding character.
`void`	`writeOEMStrings(Collection<String> strings)` Converts an array of unicode strings to ASCII bytes and writes them to file using environment dependent line separator.
`void`	`writeUnicodeString(String s)` Writes a string to its length using the OEM (ASCII) character set.
`void`	`writeUnicodeStringPadded(String s, int length, char pad)` Writes a string padded to the specified length with the padding character.
`void`	`writeZeroedBytes(int cc)` Write a number of zero'ed bytes.

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

- Field Detail
  - newLine
```
public static final String newLine
```
    The New Line separator.
  - isoNewLine
```
public static final byte[] isoNewLine
```
    The New Line separator bytes for ISO character encoding.
- Constructor Detail
  - PhantomOutputFile
```
public PhantomOutputFile(File file)
                  throws IOException
```
    Creates the specified file for write.
    Throws:
    IOException - if an I/O error occurs.
  - PhantomOutputFile
```
public PhantomOutputFile(String fileName)
                  throws IOException
```
    Creates the specified file for write.
    Throws:
    IOException - if an I/O error occurs.
  - PhantomOutputFile
```
public PhantomOutputFile(String fileName,
                         PhantomFile openFile)
                  throws IOException
```
    Creates the specified file for write. The directory of the file name is taken from the instance of the PhantomFile passed into this method.
    Throws:
    IOException - if an I/O error occurs.
  - PhantomOutputFile
```
public PhantomOutputFile(String fileName,
                         String previousFile)
                  throws IOException
```
    Creates the specified file for write. The directory of the file name is taken from the file name passed into this method.
    Throws:
    IOException - if an I/O error occurs.
  - PhantomOutputFile
```
public PhantomOutputFile(OutputStream out)
```
    Creates an instance for the output stream.
  - PhantomOutputFile
```
public PhantomOutputFile()
```
    Creates a in-memory byte array output stream where the contents can be retrieved by means of getByteArrayOutputStream() or getByteArray() methods.
- Method Detail
  - setCodePages
```
public void setCodePages(String ansiCP,
                         String oemCP)
                  throws IOException
```
    Sets the Ansi and OEM code pages.
    Parameters:
    ansiCP - The Ansi codepage, null for default.
    oemCP - The OEM codepage, null for default.
    Throws:
    IOException - For file errors or codepage does not exist (file is closed).
  - setNetPhantom5
```
public void setNetPhantom5(boolean isNetPhantom5)
```
    Sets the NetPhantom 5 flag.
    Parameters:
    isNetPhantom5 - Flag for NetPhantom 5 file.
  - isNetPhantom5File
```
public boolean isNetPhantom5File()
```
    Checks if the file is used to write data for NetPhantom 5 or not.
  - close
```
public void close()
           throws IOException
```
    Close stream and file
    Throws:
    IOException - if an I/O error occurs.
  - getDataOutputStream
```
public DataOutputStream getDataOutputStream()
```
    Gets the data output stream instance.
  - getFileOutputStream
```
public FileOutputStream getFileOutputStream()
```
    Gets the file output stream instance. This method returns null when the PhantomOutputFile is an in-memory byte array output stream.
  - getByteArrayOutputStream
```
public ByteArrayOutputStream getByteArrayOutputStream()
```
    Gets the byte array output stream instance. This method returns null when the PhantomOutputFile is not an in-memory byte array output stream, but rather an output file.
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Gets the file output stream instance.
  - getByteArray
```
public byte[] getByteArray()
```
    Gets the written data as a byte array when the file refers to an in-memory file. Otherwise null is returned.
  - writeBytes
```
public void writeBytes(byte[] d)
                throws IOException
```
    Write a byte array to the file.
    Throws:
    IOException - if an I/O error occurs.
  - writeBytes
```
public void writeBytes(byte[] d,
                       int offset,
                       int length)
                throws IOException
```
    Write a byte array to the file.
    Throws:
    IOException - if an I/O error occurs.
  - writeByte
```
public void writeByte(byte d)
               throws IOException
```
    Write a byte to the file.
    Throws:
    IOException - if an I/O error occurs.
  - writeByte
```
public void writeByte(int d)
               throws IOException
```
    Write a byte to the file.
    Throws:
    IOException - if an I/O error occurs.
  - writeZeroedBytes
```
public void writeZeroedBytes(int cc)
                      throws IOException
```
    Write a number of zero'ed bytes.
    Throws:
    IOException
  - writeBoolean
```
public void writeBoolean(boolean b)
                  throws IOException
```
    Write a number of zero'ed bytes.
    Throws:
    IOException
  - writeIntelLong
```
public void writeIntelLong(int v)
                    throws IOException
```
    Writes an Intel formatted Long (32 bit value). It doesn't matter if it's a ULong or Long (signed value), because the 32 bit implementation will always treat it as signed.
    Throws:
    IOException - if an I/O error occurs.
  - writeIntelShort
```
public void writeIntelShort(int v)
                     throws IOException
```
    Writes an Intel formatted Short (16 bit signed value).
    Throws:
    IOException - if an I/O error occurs.
  - writeIntelUShort
```
public void writeIntelUShort(int v)
                      throws IOException
```
    Writes an Intel formatted UShort (16 bit unsigned value).
    Throws:
    IOException - if an I/O error occurs.
  - writeIntelDouble
```
public void writeIntelDouble(double value)
                      throws IOException
```
    Writes a double value from the file.
    Parameters:
    value -
    Throws:
    IOException - if an I/O error occurs.
  - writeLine
```
public void writeLine(byte[] line)
               throws IOException
```
    Writes an array of bytes to file and append line separator.
    Throws:
    IOException - if an I/O error occurs.
  - writeISOLine
```
public void writeISOLine(String line)
                  throws IOException
```
    Writes a string as a line in a file encoded in ISO 8859-1 character set. The line is terminated with [CR]LF (Hex [0x0D] 0x0A) only in order to have the same character under Windows, Unix and EBCDIC environments.
    Typically, this function is used to write data that is then read with PhantomFile.readISOLine.
    Throws:
    IOException - if an I/O error occurs.
    See Also:
    PhantomFile.readISOLine()
  - writeUnicodeString
```
public void writeUnicodeString(String s)
                        throws IOException
```
    Writes a string to its length using the OEM (ASCII) character set.
    Throws:
    IOException - if an I/O error occurs.
  - writeUnicodeStringPadded
```
public void writeUnicodeStringPadded(String s,
                                     int length,
                                     char pad)
                              throws IOException
```
    Writes a string padded to the specified length with the padding character. If the string is longer than the specified length, it will be truncated.
    Throws:
    IOException - if an I/O error occurs.
  - writeOEMStrings
```
public void writeOEMStrings(Collection<String> strings)
                     throws IOException
```
    Converts an array of unicode strings to ASCII bytes and writes them to file using environment dependent line separator.
    Throws:
    IOException - if an I/O error occurs.
  - writeAnsiStrings
```
public void writeAnsiStrings(Collection<String> strings)
                      throws IOException
```
    Converts an array of unicode strings to Ansi bytes and writes them to file using environment dependent line separator.
    Throws:
    IOException - if an I/O error occurs.
  - writeOEMString
```
public void writeOEMString(String s)
                    throws IOException
```
    Writes a string to its length using the OEM (ASCII) character set.
    Throws:
    IOException - if an I/O error occurs.
  - writeAnsiString
```
public void writeAnsiString(String s)
                     throws IOException
```
    Writes a string to its length using the Ansi character set.
    Throws:
    IOException - if an I/O error occurs.
  - writeOEMStringPadded
```
public void writeOEMStringPadded(String s,
                                 int length,
                                 char pad)
                          throws IOException
```
    Writes a string padded to the specified length with the padding character. If the string is longer than the specified length, it will be truncated.
    Throws:
    IOException - if an I/O error occurs.
  - writeAnsiStringPadded
```
public void writeAnsiStringPadded(String s,
                                  int length,
                                  char pad)
                           throws IOException
```
    Writes an Ansi string padded to the specified length with the padding character. If the string is longer than the specified length, it will be truncated.
    Throws:
    IOException - if an I/O error occurs.
  - writeOEMStringNullTerminated
```
public void writeOEMStringNullTerminated(String s,
                                         int length)
                                  throws IOException
```
    Writes an OEM string padded to the specified length with the zero padding character. If the string is longer or equal to the specified length, it will be truncated, thus an ending null byte is always present.
    Throws:
    IOException - if an I/O error occurs.
  - writeAnsiStringNullTerminated
```
public void writeAnsiStringNullTerminated(String s,
                                          int length)
                                   throws IOException
```
    Writes an Ansi string padded to the specified length with the zero padding character. If the string is longer or equal to the specified length, it will be truncated, thus an ending null byte is always present.
    Throws:
    IOException - if an I/O error occurs.

Class PhantomOutputFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

newLine

isoNewLine

Constructor Detail

PhantomOutputFile

PhantomOutputFile

PhantomOutputFile

PhantomOutputFile

PhantomOutputFile

PhantomOutputFile

Method Detail

setCodePages

setNetPhantom5

isNetPhantom5File

close

getDataOutputStream

getFileOutputStream

getByteArrayOutputStream

getOutputStream

getByteArray

writeBytes

writeBytes

writeByte

writeByte

writeZeroedBytes

writeBoolean

writeIntelLong

writeIntelShort

writeIntelUShort

writeIntelDouble

writeLine

writeISOLine

writeUnicodeString

writeUnicodeStringPadded

writeOEMStrings

writeAnsiStrings

writeOEMString

writeAnsiString

writeOEMStringPadded

writeAnsiStringPadded

writeOEMStringNullTerminated

writeAnsiStringNullTerminated