FileStream (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.Stream
- - com.goldencode.p2j.util.FileStream

All Implemented Interfaces:

Finalizable

Direct Known Subclasses:

CachedInputStream, ImportWorker.DataFileReader
```
public class FileStream
extends Stream
```
A stream class supporting input and output semantics for any file-like file system object (file or device). The backing construct is not really a "stream" because it must provide methods to get and set the current offset (the current read/write position) into the stream.

Author:

GES

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileStream.BOM
A structure that identifies the know types of BOMs and their useful properties.
- Nested classes/interfaces inherited from class com.goldencode.p2j.util.Stream
  Stream.PrintMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileStream.BOM` A structure that identifies the know types of BOMs and their useful properties.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`baseDirectoryName` The name of the directory of the file.
`protected java.nio.ByteBuffer`	`binaryBuffer` Buffer for mapped file usage; this is in memory only if `mapped` flag is `true`.
`private byte[]`	`buffer` Buffer used for non-memory-mapped writes.
`private java.lang.Byte[]`	`byteMapping` The current byte mapping, if any, otherwise, `null`.
`private int`	`currLineNumber` The current line nunber under reading for the source file.
`protected java.nio.charset.CharsetDecoder`	`decoder` The cached character decoder used in more complex operations.
`protected java.nio.channels.FileChannel`	`file` The backing construct for the "stream".
`protected java.lang.String`	`fileName` The name of the file.
`private boolean`	`hasDuplicatedLastLine` Flag to indicate if the last line in the file is duplicate (true for LOB files).
`protected java.lang.String`	`lobDirectoryName` The name of the directory to store LOB.
`private boolean`	`mapped` `true` if using memory mapped file support.
`protected static int`	`MAPPED_BUF_SZ` The maximum size of mapped memory "chunks".
`private boolean`	`memoryMapped` Flag indicating if this is a memory-mapped stream.
`private long`	`memsz` The size (in bytes) of the memory mapped buffer.
`private long`	`offset` The starting offset (in bytes) of the memory mapped buffer.
`private int`	`optionalBOMSize` Optional BOM signature size to be skipped for text files.
`private int`	`pending` Number of bytes in the write buffer (non-memory-mapped mode).
`private boolean`	`write` `true` if the file must be writable.
`private static int`	`WRITE_BUF_SZ` The size of the non-memory mapped write buffer.

Fields inherited from class com.goldencode.p2j.util.Stream
_convert, binary, convert, convertCached, CR, CRLF, DELIM, doneIn, doneOut, EOF, increment, internalCp, isWindows, LF, mapEntryProtermcap, MODE_EXPORT, MODE_PUT_CONTROL, MODE_PUT_NORMAL, MODE_PUT_UNFORMATTED, NEW_LINES, NEWLINE, NEWLINE_LEN, noMap, PAGED_DEFAULT, PIPE_BROKEN_MESSAGE, SET_PAGED_DEFAULT, sourceCharset, sourceCp, streamCp, targetCharset, targetCp, UNKNOWN_VALUE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FileStream()` Default constructor.
	`FileStream(java.lang.String filename, boolean write, boolean append)` Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given `write` flag.
`protected`	`FileStream(java.lang.String filename, boolean write, boolean append, boolean memoryMapped, FileSystemResource fsr)` Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given `write` flag.
`protected`	`FileStream(java.lang.String filename, boolean write, boolean append, boolean memoryMapped, FileSystemResource fsr, boolean hasDuplicatedLastLine)` Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given `write` flag.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`allocate()` Allocate the write buffer if it is not already allocated.
`void`	`assign(Stream stream)` Assigns the internal stream reference to the given reference.
`long`	`available()` The number of bytes available to be immediately read without blocking.
`void`	`close()` Closes the stream and releases OS resources associated with it.
`void`	`closeIn()` Closes the input stream and releases OS resources associated with it.
`void`	`closeOut()` Closes the output stream and releases OS resources associated with it.
`protected java.nio.CharBuffer`	`decode(byte[] bytes)` Decode the specified bytes using the `Stream.sourceCharset` or the cached `decoder`, if set.
`protected java.nio.CharBuffer`	`decode(byte[] bytes, boolean throwIO)` Decode the specified bytes using the `Stream.sourceCharset` or the cached `decoder`, if set.
`void`	`flush()` Flushes any data remaining in buffers to file or device.
`private void`	`flushBuffered()` Output any buffered writes to the file.
`protected void`	`flushData()` Flushes this output stream and forces any buffered output bytes to be written out.
`long`	`getLen()` The length of the stream in bytes.
`private java.lang.String`	`getLobDirectory()` Gets the stream's lob directory defined to put/get lob data fields.
`long`	`getPos()` The 0-based offset into the stream at which the next read or write will occur.
`int64`	`getPosition()` Obtains the current read and/or write position in the stream, if the stream type supports such a query.
`protected void`	`initBinaryBuffer(long start, long size)` Initialize the binary buffer storage with content of the file or steam to be read depending on class implementation..
`protected boolean`	`isFileResource()` Check if this is a file resource.
`boolean`	`isIn()` State of the input side of the stream.
`boolean`	`isOut()` State of the output side of the stream.
`protected void`	`map(long start)` Setup memory mapping starting at the given offset and extending to the end of the file or to the maximum chunk size, whichever is smaller.
`private boolean`	`mappingInvalidBytesEnabled()` Test whether a bye mapping array is in use.
`int`	`peekCh()` Peeks at the character from the current read position in the stream (reads a character from the current read position in the stream without incrementing stream read position.
`protected FileStream.BOM`	`readBOM()` Attempt to detect the file encoding based on the BOM.
`int`	`readByte()` Read a single byte from the underlying stream.
`byte[]`	`readBytes(int len)` Read a chunk of bytes from the current read position in the stream to the offset calculated by given length or to the `EOF`, whichever comes first.
`private int`	`readByteWorker(boolean peek)` Read a byte from the file at the current file pointer.
`int`	`readCh()` Read the raw integer value of a character from the current read position in the stream.
`private int`	`readCharacterWorker(boolean peek)` Read a character from the file at the current file pointer.
`java.lang.String`	`readLn()` Read all characters from the current read position in the stream to the next line separator (as determined by the `File.separator` or to the `EOF`.
`void`	`setConvertSource(java.lang.String cp)` Sets the stream's source codepage and activates character conversion mode.
`void`	`setInvalidBytesMapping(java.lang.Byte[] newByteMapping)` Sets a new mapping byte array.
`void`	`setLen(long len)` Truncates or extends the stream to the specified length if this stream supports such an operation.
`void`	`setLobDirectory(java.lang.String lobDir)` Sets the stream's lob directory located as a subdirectory for opened current file stream directory.
`void`	`setPos(long pos)` Moves the current read/write position to the specified absolute 0-based offset.
`void`	`setPosition(long newpos)` Sets the current read and/or write position in the stream, if the stream type supports the operation.
`private void`	`skipBOMHeader()` Skips file internal pointer for the text files to the value of the BOM size from the file beginning.
`protected void`	`unmap()` Clear/release the memory mapped buffer.
`private void`	`write(byte b)` Worker to output a single byte to our file at the current output position.
`void`	`write(byte[] data)` Write the given byte array to the output stream.
`void`	`write(byte[] data, int off, int len)` Write the specified range of bytes from the given byte array to the output stream.
`void`	`write(java.lang.String data)` Write the given string to the output stream.
`void`	`writeBlob(blob val)` Write the entire block of data (as represented by the given `blob`) to the stream with no delimiters, end of line insertions or other modifications.
`void`	`writeByte(byte b)` Write the given byte to the output stream.
`void`	`writeCh(char ch)` Write the given character to the output stream.
`void`	`writeClob(clob val)` Write the entire block of data (as represented by the given `clob`) to the stream with no delimiters, end of line insertions or other modifications.
`private void`	`writeFully(java.nio.ByteBuffer[] buf, int[] sz, int len)` Write `len` bytes from the given buffer to the file before returning.
`private void`	`writeFully(java.nio.ByteBuffer buf, int len)` Write `len` bytes from the given buffer to the file before returning.
`private void`	`writeWorker(byte b)` Write a byte to the buffer, flushing if the buffer is full.
`private void`	`writeWorker(byte[] data, int offset, int len)` Worker that provides a mechanism to write a buffer directly to the file channel at the current write position.

Methods inherited from class com.goldencode.p2j.util.Stream
advancePage, afterWrite, assignDatum, cleanup, deleted, deregisterFooter, deregisterHeader, endOutput, endOutput, export, finished, flushControlled, forcePageBreak, forcePageBreak, generateStringFormat, getAvailableLines, getControl, getConvert, getDelimiter, getDisplayMode, getEcho, getEffectivePageSize, getLength, getName, getNextLineNum, getPageNum, getPageSize, getPendingRowCount, getPulseOnClose, getUnformatted, hasPageHeadersFooters, indexOfNewLine, isContiguous, isFreshPage, isKeepMessages, isNewLine, isSilent, isSuppressFormFeed, isTerm, isUnbuffered, isUnnamed, isValid, iterate, needsHeadersOutput, needsPageBreak, needsPageBreak, processFooters, processHeaders, processHeadersInt, processHeadersUncond, protectReads, protectWrites, pulseOutput, put, putControl, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putField, putLineEnd, putLineEnd, putNull, putNull, putSpace, putSpace, putUnformatted, putWorker, rawGetNextLineNum, rawGetPageNum, rawGetPageSize, rawIncrementNextLineNum, rawIncrementPageNum, rawNextLineNum, rawPageSize, rawResetNextLineNum, rawSetPageSize, readBlock, readBlockRemote, readBlockWorker, readChar, readChar, readChunk, readField, readField, readField, readField, readFieldWorker, readLine, readLine, readLine, readLine, readLineCleanup, registerAdvanceListener, registerCloseListener, registerFlushListener, registerFooter, registerHeader, registerPageBreakListener, resetCurrentLine, retry, setAppend, setBinary, setContiguous, setControl, setConvert, setConvertSource, setConvertTarget, setConvertTarget, setDelimiter, setDelimiter, setEcho, setFlushBeforePut, setFont, setFont, setKeepMessages, setLandscape, setLobDirectory, setMap, setName, setNoMap, setPageSize, setPageSize, setPageSize, setPendingRowCount, setPortrait, setPosition, setPulseOnClose, setUnbuffered, setUnformatted, setUnnamed, skipField, skipLoneHyphenInput, startOutput, writeBlock, writeControlled, writeControlledSpecial, writeField, writeField, writeField, writeField, writeField

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

Methods inherited from interface com.goldencode.p2j.util.Finalizable
entry, initFailure, weight

- Field Detail
  - MAPPED_BUF_SZ
```
protected static final int MAPPED_BUF_SZ
```
    The maximum size of mapped memory "chunks".
    
    See Also:
    
    Constant Field Values
  - WRITE_BUF_SZ
```
private static final int WRITE_BUF_SZ
```
    The size of the non-memory mapped write buffer.
    
    See Also:
    
    Constant Field Values
  - memoryMapped
```
private final boolean memoryMapped
```
    Flag indicating if this is a memory-mapped stream. Can be set only by sub-classes.
  - hasDuplicatedLastLine
```
private final boolean hasDuplicatedLastLine
```
    Flag to indicate if the last line in the file is duplicate (true for LOB files).
  - mapped
```
private boolean mapped
```
    true if using memory mapped file support.
  - write
```
private boolean write
```
    true if the file must be writable.
  - file
```
protected java.nio.channels.FileChannel file
```
    The backing construct for the "stream".
  - binaryBuffer
```
protected java.nio.ByteBuffer binaryBuffer
```
    Buffer for mapped file usage; this is in memory only if mapped flag is true.
  - decoder
```
protected java.nio.charset.CharsetDecoder decoder
```
    The cached character decoder used in more complex operations.
  - offset
```
private long offset
```
    The starting offset (in bytes) of the memory mapped buffer.
  - memsz
```
private long memsz
```
    The size (in bytes) of the memory mapped buffer.
  - buffer
```
private byte[] buffer
```
    Buffer used for non-memory-mapped writes.
  - pending
```
private int pending
```
    Number of bytes in the write buffer (non-memory-mapped mode).
  - byteMapping
```
private java.lang.Byte[] byteMapping
```
    The current byte mapping, if any, otherwise, null.
  - fileName
```
protected final java.lang.String fileName
```
    The name of the file.
  - baseDirectoryName
```
protected final java.lang.String baseDirectoryName
```
    The name of the directory of the file.
  - lobDirectoryName
```
protected java.lang.String lobDirectoryName
```
    The name of the directory to store LOB.
  - currLineNumber
```
private int currLineNumber
```
    The current line nunber under reading for the source file.
  - optionalBOMSize
```
private int optionalBOMSize
```
    Optional BOM signature size to be skipped for text files.
- Constructor Detail
  - FileStream
```
public FileStream()
```
    Default constructor. Inits some variables to default values.
  - FileStream
```
public FileStream(java.lang.String filename,
                  boolean write,
                  boolean append)
           throws ErrorConditionException
```
    Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given write flag. The current read/write position will be at offset 0 unless in write mode and the append flag is on.
    
    Parameters:
    
    filename - The name of the file or device to open.
    
    write - If true, open in write mode, otherwise only open the file for reading.
    
    append - In write mode, if true, the current file pointer is set to the end of the file. Otherwise if in write mode, the file is truncated to 0 length. This value is ignored in read mode.
    
    Throws:
    
    ErrorConditionException - - If the file does not exist. - If the current user does not have the proper rights to open the file or device.
  - FileStream
```
protected FileStream(java.lang.String filename,
                     boolean write,
                     boolean append,
                     boolean memoryMapped,
                     FileSystemResource fsr)
              throws ErrorConditionException
```
    Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given write flag. The current read/write position will be at offset 0 unless in write mode and the append flag is on.
    
    Parameters:
    
    filename - The name of the file or device to open.
    
    write - If true, open in write mode, otherwise only open the file for reading.
    
    append - In write mode, if true, the current file pointer is set to the end of the file. Otherwise if in write mode, the file is truncated to 0 length. This value is ignored in read mode.
    
    memoryMapped - Flag indicating if the mapping is done in memory. Only for read-only files.
    
    fsr - The file system resource to use for this stream. May be null if no resource checking is required.
    
    Throws:
    
    ErrorConditionException - - If the file does not exist. - If the current user does not have the proper rights to open the file or device.
  - FileStream
```
protected FileStream(java.lang.String filename,
                     boolean write,
                     boolean append,
                     boolean memoryMapped,
                     FileSystemResource fsr,
                     boolean hasDuplicatedLastLine)
              throws ErrorConditionException
```
    Constructs an instance using a filename, this file or device will be opened for reading or writing based on the given write flag. The current read/write position will be at offset 0 unless in write mode and the append flag is on.
    
    Parameters:
    
    filename - The name of the file or device to open.
    
    write - If true, open in write mode, otherwise only open the file for reading.
    
    append - In write mode, if true, the current file pointer is set to the end of the file. Otherwise if in write mode, the file is truncated to 0 length. This value is ignored in read mode.
    
    memoryMapped - Flag indicating if the mapping is done in memory. Only for read-only files.
    
    fsr - The file system resource to use for this stream. May be null if no resource checking is required.
    
    hasDuplicatedLastLine - Flag to indicate if the last line in the file is duplicate (true for LOB files).
    
    Throws:
    
    ErrorConditionException - - If the file does not exist. - If the current user does not have the proper rights to open the file or device.
- Method Detail
  - flush
```
public void flush()
```
    Flushes any data remaining in buffers to file or device.
    
    Overrides:
    
    flush in class Stream
  - available
```
public long available()
               throws java.io.IOException
```
    The number of bytes available to be immediately read without blocking.
    
    Specified by:
    
    available in class Stream
    
    Returns:
    
    The number of available bytes.
    
    Throws:
    
    java.io.IOException - if a problem was encountered wile processing the file.
  - getPos
```
public long getPos()
            throws java.io.IOException
```
    The 0-based offset into the stream at which the next read or write will occur.
    
    Specified by:
    
    getPos in class Stream
    
    Returns:
    
    The current position in the stream.
    
    Throws:
    
    java.io.IOException - if a problem was encountered wile processing the file.
  - setPos
```
public void setPos(long pos)
            throws java.io.IOException
```
    Moves the current read/write position to the specified absolute 0-based offset.
    
    Specified by:
    
    setPos in class Stream
    
    Parameters:
    
    pos - The new read/write position in the stream.
    
    Throws:
    
    java.io.IOException - if a problem was encountered wile processing the file.
  - isIn
```
public boolean isIn()
```
    State of the input side of the stream.
    
    Specified by:
    
    isIn in class Stream
    
    Returns:
    
    true if the input side of the stream is active.
  - isOut
```
public boolean isOut()
```
    State of the output side of the stream.
    
    Specified by:
    
    isOut in class Stream
    
    Returns:
    
    true if the output side of the stream is active.
  - getLen
```
public long getLen()
            throws java.io.IOException
```
    The length of the stream in bytes.
    
    Specified by:
    
    getLen in class Stream
    
    Returns:
    
    The length of the stream.
    
    Throws:
    
    java.io.IOException - In the event of an error while getting the length of the stream.
  - setLen
```
public void setLen(long len)
            throws java.io.IOException
```
    Truncates or extends the stream to the specified length if this stream supports such an operation. If truncation is requested, all data located after this point in the file is discarded. If extending the file is requested, the values of the data in the extended portion of the file is undefined.
    
    Specified by:
    
    setLen in class Stream
    
    Parameters:
    
    len - The new length of the file.
    
    Throws:
    
    java.io.IOException - In the event of an error while setting the size of the stream.
  - writeCh
```
public void writeCh(char ch)
             throws java.io.IOException
```
    Write the given character to the output stream. On Windows non-binary streams, the EOLN characters (LF) are converted to proper CRLF sequence.
    
    Specified by:
    
    writeCh in class Stream
    
    Parameters:
    
    ch - The character to be written.
    
    Throws:
    
    java.io.IOException - In the event of an error while writing the character.
  - writeByte
```
public void writeByte(byte b)
               throws java.io.IOException
```
    Write the given byte to the output stream. On Windows non-binary streams, the EOLN characters (LF) are converted to proper CRLF sequence.
    
    Specified by:
    
    writeByte in class Stream
    
    Parameters:
    
    b - The byte to be written.
    
    Throws:
    
    java.io.IOException - In the event of an error while writing the byte.
  - write
```
public void write(java.lang.String data)
           throws java.io.IOException
```
    Write the given string to the output stream.
    
    Specified by:
    
    write in class Stream
    
    Parameters:
    
    data - The data to be written.
    
    Throws:
    
    java.io.IOException - In the event of an error while writing the string value.
  - peekCh
```
public int peekCh()
```
    Peeks at the character from the current read position in the stream (reads a character from the current read position in the stream without incrementing stream read position. The next peekCh() and readCh() will return the same value).
    The underlying stream subclass determines the content of the result. Byte oriented streams such as pipes or files will return a byte while streams that generate keystrokes or characters may return a DBCS or Unicode character.
    
    Specified by:
    
    peekCh in class Stream
    
    Returns:
    
    The next character read from the stream, -1 on any failure and -2 upon an EOF.
  - readCh
```
public int readCh()
```
    Read the raw integer value of a character from the current read position in the stream. This method DOES NOT convert the value read from the stream's character set into Unicode.
    At this time, only a single byte will be read no matter what encoding is used by the underlying stream. This means that DBCS or Unicode encodings will not be properly handled.
    
    Specified by:
    
    readCh in class Stream
    
    Returns:
    
    The next character read from the stream, -1 on any failure and -2 upon an EOF.
  - readByte
```
public int readByte()
```
    Read a single byte from the underlying stream.
    
    Specified by:
    
    readByte in class Stream
    
    Returns:
    
    A single byte from the stream.
  - readBytes
```
public byte[] readBytes(int len)
                 throws java.io.IOException
```
    Read a chunk of bytes from the current read position in the stream to the offset calculated by given length or to the EOF, whichever comes first. The EOF character is not returned.
    
    Overrides:
    
    readBytes in class Stream
    
    Parameters:
    
    len - The number of bytes to read.
    
    Returns:
    
    The chunk read from the stream or null if there is nothing to read (the EOF has been reached). The length of the returned array will be the smaller of the len parameter or the actual bytes left before the EOF.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
  - readLn
```
public java.lang.String readLn()
                        throws java.io.EOFException,
                               java.io.IOException,
                               java.lang.InterruptedException
```
    Read all characters from the current read position in the stream to the next line separator (as determined by the File.separator or to the EOF. Any line separator character(s) and the EOF character are not returned.
    
    Specified by:
    
    readLn in class Stream
    
    Returns:
    
    The next line read from the stream.
    
    Throws:
    
    java.io.EOFException - When attempting to read past the end of the file.
    
    java.io.IOException - In the event of an other error while reading the line.
    
    java.lang.InterruptedException - If the thread was interrupted while it was blocked reading the stream.
  - closeIn
```
public void closeIn()
```
    Closes the input stream and releases OS resources associated with it.
    
    Specified by:
    
    closeIn in class Stream
  - closeOut
```
public void closeOut()
```
    Closes the output stream and releases OS resources associated with it.
    
    Specified by:
    
    closeOut in class Stream
  - close
```
public void close()
```
    Closes the stream and releases OS resources associated with it.
    
    Specified by:
    
    close in class Stream
  - assign
```
public void assign(Stream stream)
            throws java.lang.UnsupportedOperationException
```
    Assigns the internal stream reference to the given reference.
    
    Specified by:
    
    assign in class Stream
    
    Parameters:
    
    stream - The new internal stream reference to use for all operations.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always since this type of stream objects does not support assign operations.
  - write
```
public void write(byte[] data)
           throws java.io.IOException
```
    Write the given byte array to the output stream.
    
    Specified by:
    
    write in class Stream
    
    Parameters:
    
    data - The data to be written.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
  - write
```
public void write(byte[] data,
                  int off,
                  int len)
           throws java.io.IOException
```
    Write the specified range of bytes from the given byte array to the output stream.
    
    Specified by:
    
    write in class Stream
    
    Parameters:
    
    data - The data to be written.
    
    off - Starting offset in data from which to read bytes to be written. Must be non-negative and < data.length.
    
    len - Length of data to be written. Must be non-negative and <= (data.length - offset).
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
  - writeBlob
```
public void writeBlob(blob val)
               throws ErrorConditionException,
                      StopConditionException
```
    Write the entire block of data (as represented by the given blob) to the stream with no delimiters, end of line insertions or other modifications. The data will be exported into separate file within subdirectory defined in LOB-DIR option or if not defined in current base directory.
    Use of this method does NOT require bracketing between Stream.startOutput(int) and Stream.endOutput() methods and these must not be called otherwise the result is undefined.
    This method is called only from client-side, via the ExportField.output method. WARNING: any other usage from server-side needs to be reviewed, as it may be expensive.
    
    Overrides:
    
    writeBlob in class Stream
    
    Parameters:
    
    val - The value to be output.
    
    Throws:
    
    ErrorConditionException - On any error during I/O.
    
    StopConditionException - If any interruption occurs during I/O processing.
  - writeClob
```
public void writeClob(clob val)
               throws ErrorConditionException,
                      StopConditionException
```
    Write the entire block of data (as represented by the given clob) to the stream with no delimiters, end of line insertions or other modifications. The data will be exported into separate file within subdirectory defined in LOB-DIR option or if not defined in current base directory.
    Use of this method does NOT require bracketing between Stream.startOutput(int) and Stream.endOutput() methods and these must not be called otherwise the result is undefined.
    This method is called only from client-side, via the ExportField.output method. WARNING: any other usage from server-side needs to be reviewed, as it may be expensive.
    
    Overrides:
    
    writeClob in class Stream
    
    Parameters:
    
    val - The value to be output.
    
    Throws:
    
    ErrorConditionException - On any error during I/O.
    
    StopConditionException - If any interruption occurs during I/O processing.
  - isFileResource
```
protected boolean isFileResource()
```
    Check if this is a file resource.
    
    Overrides:
    
    isFileResource in class Stream
    
    Returns:
    
    Always true
  - flushData
```
protected void flushData()
                  throws java.io.IOException
```
    Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.
    
    Overrides:
    
    flushData in class Stream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - getLobDirectory
```
private java.lang.String getLobDirectory()
```
    Gets the stream's lob directory defined to put/get lob data fields.
    
    Returns:
    
    The path for LOB directory, no trailing file separator.
  - write
```
private void write(byte b)
            throws java.io.IOException
```
    Worker to output a single byte to our file at the current output position.
    
    Parameters:
    
    b - The data to write.
    
    Throws:
    
    java.io.IOException
  - writeWorker
```
private void writeWorker(byte b)
                  throws java.io.IOException
```
    Write a byte to the buffer, flushing if the buffer is full.
    
    Parameters:
    
    b - The byte to write.
    
    Throws:
    
    java.io.IOException
  - writeWorker
```
private void writeWorker(byte[] data,
                         int offset,
                         int len)
                  throws java.io.IOException
```
    Worker that provides a mechanism to write a buffer directly to the file channel at the current write position.
    
    Parameters:
    
    data - The buffer to write.
    
    offset - The starting index to output.
    
    len - The number of bytes to output.
    
    Throws:
    
    java.io.IOException
  - readCharacterWorker
```
private int readCharacterWorker(boolean peek)
                         throws java.io.IOException
```
    Read a character from the file at the current file pointer.
    
    Parameters:
    
    peek - true if the character is only peeked, ie the file pointer is not incremented.
    
    Returns:
    
    The next character read or -1 if EOF is reached.
    
    Throws:
    
    java.io.IOException
  - readByteWorker
```
private int readByteWorker(boolean peek)
                    throws java.io.IOException
```
    Read a byte from the file at the current file pointer.
    
    Parameters:
    
    peek - true if the byte is only peeked, ie the file pointer is not incremented.
    
    Returns:
    
    The next byte read or -1 if EOF is reached.
    
    Throws:
    
    java.io.IOException
  - allocate
```
private void allocate()
```
    Allocate the write buffer if it is not already allocated.
  - flushBuffered
```
private void flushBuffered()
                    throws java.io.IOException
```
    Output any buffered writes to the file. This only affects writes at the end of the file (non-mapped mode). If called while in mapped mode this is a NOP.
    
    Throws:
    
    java.io.IOException
  - writeFully
```
private void writeFully(java.nio.ByteBuffer buf,
                        int len)
                 throws java.io.IOException
```
    Write len bytes from the given buffer to the file before returning.
    
    Parameters:
    
    buf - The buffer to output.
    
    len - The size of the buffer in bytes. This MUST NOT be different than the amount of data in the buffer. It is provided here only for efficiency since the callers of this method already have this value.
    
    Throws:
    
    java.io.IOException
  - writeFully
```
private void writeFully(java.nio.ByteBuffer[] buf,
                        int[] sz,
                        int len)
                 throws java.io.IOException
```
    Write len bytes from the given buffer to the file before returning. This takes advantage of the NIO scatter/gather functionality to improve performance.
    
    Parameters:
    
    buf - The list of buffers to output.
    
    sz - The size in bytes of each corresponding buffer. The length of this array must be the same as that of buf.
    
    len - The cumulative size of the data in all buffers in bytes. This MUST NOT be different than the amount of data in the buffer. It is provided here only for efficiency since the callers of this method already have this value.
    
    Throws:
    
    java.io.IOException
  - readBOM
```
protected FileStream.BOM readBOM()
```
    Attempt to detect the file encoding based on the BOM.
    
    Returns:
    
    A BOM structure containing data about character encoding if one is detected, otherwise null.
  - setConvertSource
```
public void setConvertSource(java.lang.String cp)
```
    Sets the stream's source codepage and activates character conversion mode.
    
    Overrides:
    
    setConvertSource in class Stream
    
    Parameters:
    
    cp - The source codepage for character conversion mode.
  - setLobDirectory
```
public void setLobDirectory(java.lang.String lobDir)
```
    Sets the stream's lob directory located as a subdirectory for opened current file stream directory.
    
    Overrides:
    
    setLobDirectory in class Stream
    
    Parameters:
    
    lobDir - The name for subdirectory to store LOB files.
  - setInvalidBytesMapping
```
public void setInvalidBytesMapping(java.lang.Byte[] newByteMapping)
```
    Sets a new mapping byte array. Note that the method DOES NOT make a copy of the array, but it is guaranteed that this object does not alter the array in any way so that the same instance of the array may be used by multiple FileStreams at no memory/CPU expense to copy and store individual instances of the array.
    
    Parameters:
    
    newByteMapping - The new byte mapping. An array of 256 bytes values with mapping of bytes. All bytes must be mapped. If no special mapping is necessary use newByteMapping[i] = i;. Use null to disable byte mapping.
  - setPosition
```
public void setPosition(long newpos)
```
    Sets the current read and/or write position in the stream, if the stream type supports the operation.
    Starting with OpenEdge Release 10.1B, ABL includes a 64-bit integer data type. They are mapped to the underlying Java platform that can handle streams with offsets that are based on a 64-bit long.
    A negative offset is ignored (no action is taken).
    If the specified offset is larger than the length of the stream, in Progress the seek position will report as the number requested, but if no subsequent writes occur to the file, the file size is left the same as it was before setting the position. If writes do occur, all writes occur at the new position. In this case, the resulting file will be sized based on the requested offset + the number of bytes written.
    
    Overrides:
    
    setPosition in class Stream
    
    Parameters:
    
    newpos - The new offset. If this is the unknown value, the set operation will silently return without any change.
  - getPosition
```
public int64 getPosition()
```
    Obtains the current read and/or write position in the stream, if the stream type supports such a query.
    Starting with OpenEdge Release 10.1B, ABL includes a 64-bit integer data type. They are mapped to the underlying Java platform that can handle streams with offsets that are based on a 64-bit long.
    
    Overrides:
    
    getPosition in class Stream
    
    Returns:
    
    The current offset into the stream or the unknown value if the stream type doesn't support a stream position.
  - map
```
protected void map(long start)
            throws java.io.IOException
```
    Setup memory mapping starting at the given offset and extending to the end of the file or to the maximum chunk size, whichever is smaller. If the file size is 0 or the starting offset is greater than or equal to the file size, then shift into unmapped mode.
    
    Parameters:
    
    start - The starting offset (0-based) in bytes.
    
    Throws:
    
    java.io.IOException
  - initBinaryBuffer
```
protected void initBinaryBuffer(long start,
                                long size)
                         throws java.io.IOException
```
    Initialize the binary buffer storage with content of the file or steam to be read depending on class implementation..
    
    Parameters:
    
    start - The starting position inside source buffer.
    
    size - The size of the binary buffer to re-allocate.
    
    Throws:
    
    java.io.IOException - In the event of an error when decoding the bytes.
  - decode
```
protected java.nio.CharBuffer decode(byte[] bytes)
                              throws java.io.IOException
```
    Decode the specified bytes using the Stream.sourceCharset or the cached decoder, if set.
    For multi-byte characters, this API expects for all of them to be available in the given array.
    
    Parameters:
    
    bytes - The bytes to be decoded.
    
    Returns:
    
    The decoded characters.
    
    Throws:
    
    java.io.IOException - In the event of an error when decoding the bytes.
  - decode
```
protected java.nio.CharBuffer decode(byte[] bytes,
                                     boolean throwIO)
                              throws java.io.IOException
```
    Decode the specified bytes using the Stream.sourceCharset or the cached decoder, if set.
    For multi-byte characters, this API expects for all of them to be available in the given array.
    
    Parameters:
    
    bytes - The bytes to be decoded.
    
    throwIO - Flag indication if IOException will be throw in case of decoding issues.
    
    Returns:
    
    The decoded characters.
    
    Throws:
    
    java.io.IOException - In the event of an error when decoding the bytes.
  - mappingInvalidBytesEnabled
```
private boolean mappingInvalidBytesEnabled()
```
    Test whether a bye mapping array is in use.
  - skipBOMHeader
```
private void skipBOMHeader()
                    throws java.io.IOException
```
    Skips file internal pointer for the text files to the value of the BOM size from the file beginning. Not all files are considering as text ones and not all text files have BOM signature so this is optional.
    
    Throws:
    
    java.io.IOException
  - unmap
```
protected void unmap()
```
    Clear/release the memory mapped buffer.

Class FileStream

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.util.Stream

Field Summary

Fields inherited from class com.goldencode.p2j.util.Stream

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.Stream

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.util.Finalizable

Field Detail

MAPPED_BUF_SZ

WRITE_BUF_SZ

memoryMapped

hasDuplicatedLastLine

mapped

write

file

binaryBuffer

decoder

offset

memsz

buffer

pending

byteMapping

fileName

baseDirectoryName

lobDirectoryName

currLineNumber

optionalBOMSize

Constructor Detail

FileStream

FileStream

FileStream

FileStream

Method Detail

flush

available

getPos

setPos

isIn

isOut

getLen

setLen

writeCh

writeByte

write

peekCh

readCh

readByte

readBytes

readLn

closeIn

closeOut

close

assign

write

write

writeBlob

writeClob

isFileResource

flushData

getLobDirectory

write

writeWorker

writeWorker

readCharacterWorker

readByteWorker

allocate

flushBuffered

writeFully

writeFully

readBOM

setConvertSource

setLobDirectory

setInvalidBytesMapping

setPosition

getPosition

map

initBinaryBuffer