com.goldencode.p2j.util

Class CachedInputStream

java.lang.Object

com.goldencode.p2j.util.Stream

com.goldencode.p2j.util.FileStream

com.goldencode.p2j.util.CachedInputStream

All Implemented Interfaces:

Finalizable

public class CachedInputStream
extends FileStream

This class implements a cached instance of an input stream. The whole stream is cached so using instances of these objects for larger streams for longer time is not recommended.

The primary role of this class is to allow unpacked or serialized streams (from jars, or other sources) to support mark() / restore() operations.

Secondly, if the stream is traversed multiple time, the cache component is a performance improvement.

Nested Class Summary

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

FileStream.BOM

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

Stream.PrintMode

Field Summary

Fields

Modifier and Type	Field and Description
private long	len The initial full size of the stream.
(package private) java.io.InputStream	srcStream The input stream used to populate internal memory buffer.

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

baseDirectoryName, binaryBuffer, decoder, file, fileName, lobDirectoryName, MAPPED_BUF_SZ

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

Constructor and Description
CachedInputStream(byte[] ba) Default constructor.
CachedInputStream(java.io.InputStream stream) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	assign(Stream stream) Assigns the internal stream reference to the given reference.
void	close() Closes both the input and output streams 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.
long	getLen() The length of the stream in bytes.
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..
boolean	isIn() State of the input side of the stream.
boolean	isOut() State of the output side of the stream.
void	setLen(long len) Truncates or extends the stream to the specified length if this stream supports such an operation.
protected void	unmap() Clear/release the memory mapped buffer.
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	writeByte(byte b) Write the given byte to the output stream.
void	writeCh(char ch) Write the given character to the output stream.

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

available, decode, decode, flush, flushData, getPos, getPosition, isFileResource, map, peekCh, readBOM, readByte, readBytes, readCh, readLn, setConvertSource, setInvalidBytesMapping, setLobDirectory, setPos, setPosition, writeBlob, writeClob

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

len

private final long len

The initial full size of the stream.

srcStream

java.io.InputStream srcStream

The input stream used to populate internal memory buffer.

Constructor Detail

CachedInputStream

public CachedInputStream(java.io.InputStream stream)
                  throws java.io.IOException

Default constructor. Use a true InputStream as source for data.

Parameters:

stream - The stream to be cached.

Throws:

java.io.IOException - if the stream's size cannot be queried or the stream cannot be read.

CachedInputStream

public CachedInputStream(byte[] ba)

Default constructor. Use a byte array as source for data.

For performance reasons, the data in parameter is NOT copied locally, but it is guaranteed, the byte array is not exposed externally and not otherwise modified.

Parameters:

ba - The data to be cached.

Method Detail

getLen

public long getLen()
            throws java.io.IOException

The length of the stream in bytes. This does not work for "streams" that require sequential access.

Overrides:

getLen in class FileStream

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.lang.UnsupportedOperationException

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.

Overrides:

setLen in class FileStream

Parameters:

len - The new length of the file.

Throws:

java.lang.UnsupportedOperationException - Always.

writeCh

public void writeCh(char ch)
             throws java.lang.UnsupportedOperationException

Write the given character to the output stream.

Overrides:

writeCh in class FileStream

Parameters:

ch - The character to be written.

Throws:

java.lang.UnsupportedOperationException - Always.

writeByte

public void writeByte(byte b)
               throws java.lang.UnsupportedOperationException

Write the given byte to the output stream.

Overrides:

writeByte in class FileStream

Parameters:

b - The byte to be written.

Throws:

java.lang.UnsupportedOperationException - Always.

write

public void write(java.lang.String data)
           throws java.lang.UnsupportedOperationException

Write the given string to the output stream.

Overrides:

write in class FileStream

Parameters:

data - The data to be written.

Throws:

java.lang.UnsupportedOperationException - Always.

write

public void write(byte[] data)
           throws java.lang.UnsupportedOperationException

Write the given byte array to the output stream.

Overrides:

write in class FileStream

Parameters:

data - The data to be written.

Throws:

java.lang.UnsupportedOperationException - Always.

write

public void write(byte[] data,
                  int off,
                  int len)
           throws java.lang.UnsupportedOperationException

Write the specified range of bytes from the given byte array to the output stream.

Overrides:

write in class FileStream

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.lang.UnsupportedOperationException - Always.

closeIn

public void closeIn()

Closes the input stream and releases OS resources associated with it.

Overrides:

closeIn in class FileStream

closeOut

public void closeOut()

Closes the output stream and releases OS resources associated with it.

Overrides:

closeOut in class FileStream

close

public void close()

Closes both the input and output streams and releases OS resources associated with it.

Overrides:

close in class FileStream

isIn

public boolean isIn()

State of the input side of the stream.

Overrides:

isIn in class FileStream

Returns:

true if the input side of the stream is active.

isOut

public boolean isOut()

State of the output side of the stream.

Overrides:

isOut in class FileStream

Returns:

true if the output side of the stream is active.

assign

public void assign(Stream stream)
            throws java.lang.UnsupportedOperationException

Assigns the internal stream reference to the given reference.

Overrides:

assign in class FileStream

Parameters:

stream - The new internal stream reference to use for all operations.

Throws:

java.lang.UnsupportedOperationException - Always.

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..

Overrides:

initBinaryBuffer in class FileStream

Parameters:

start - The starting position inside source buffer. Not used in this class implementation.

size - The size of the binary buffer to re-allocate.

Throws:

java.io.IOException - In the event of an error when decoding the bytes.

unmap

protected void unmap()

Clear/release the memory mapped buffer.

Overrides:

unmap in class FileStream