Package com.twelvemonkeys.io
Class FileCacheSeekableStream
- java.lang.Object
-
- java.io.InputStream
-
- com.twelvemonkeys.io.SeekableInputStream
-
- com.twelvemonkeys.io.FileCacheSeekableStream
-
- All Implemented Interfaces:
Seekable
,java.io.Closeable
,java.lang.AutoCloseable
public final class FileCacheSeekableStream extends SeekableInputStream
ASeekableInputStream
implementation that caches data in a temporaryFile
.Temporary files are created as specified in
File.createTempFile(String, String, java.io.File)
.- Version:
- $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/FileCacheSeekableStream.java#5 $
- Author:
- Harald Kuhr
- See Also:
MemoryCacheSeekableStream
,FileSeekableStream
,File.createTempFile(String, String)
,RandomAccessFile
-
-
Field Summary
Fields Modifier and Type Field Description protected java.io.InputStream
stream
The backing streamprotected long
streamPosition
The stream positon in the backing stream (stream)-
Fields inherited from class com.twelvemonkeys.io.SeekableInputStream
markedPositions
-
-
Constructor Summary
Constructors Constructor Description FileCacheSeekableStream(java.io.InputStream pStream)
Creates aFileCacheSeekableStream
reading from the givenInputStream
.FileCacheSeekableStream(java.io.InputStream pStream, java.lang.String pTempBaseName)
Creates aFileCacheSeekableStream
reading from the givenInputStream
.FileCacheSeekableStream(java.io.InputStream pStream, java.lang.String pTempBaseName, java.io.File pTempDir)
Creates aFileCacheSeekableStream
reading from the givenInputStream
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
protected void
closeImpl()
protected void
flushBeforeImpl(long pPosition)
Discards the initial portion of the stream prior to the indicated postion.protected com.twelvemonkeys.io.AbstractCachedSeekableStream.StreamCache
getCache()
boolean
isCached()
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards.boolean
isCachedFile()
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file.boolean
isCachedMemory()
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards, and the cache is kept in main memory.int
read()
int
read(byte[] pBytes, int pOffset, int pLength)
protected void
seekImpl(long pPosition)
protected void
syncPosition()
-
Methods inherited from class com.twelvemonkeys.io.SeekableInputStream
checkOpen, close, finalize, flush, flushBefore, getFlushedPosition, getStreamPosition, mark, mark, markSupported, read, reset, seek, skip
-
-
-
-
Constructor Detail
-
FileCacheSeekableStream
public FileCacheSeekableStream(java.io.InputStream pStream) throws java.io.IOException
Creates aFileCacheSeekableStream
reading from the givenInputStream
. Data will be cached in a temporary file.- Parameters:
pStream
- theInputStream
to read from- Throws:
java.io.IOException
- if the temporary file cannot be created, or cannot be opened for random access.
-
FileCacheSeekableStream
public FileCacheSeekableStream(java.io.InputStream pStream, java.lang.String pTempBaseName) throws java.io.IOException
Creates aFileCacheSeekableStream
reading from the givenInputStream
. Data will be cached in a temporary file, with the given base name.- Parameters:
pStream
- theInputStream
to read frompTempBaseName
- optional base name for the temporary file- Throws:
java.io.IOException
- if the temporary file cannot be created, or cannot be opened for random access.
-
FileCacheSeekableStream
public FileCacheSeekableStream(java.io.InputStream pStream, java.lang.String pTempBaseName, java.io.File pTempDir) throws java.io.IOException
Creates aFileCacheSeekableStream
reading from the givenInputStream
. Data will be cached in a temporary file, with the given base name, in the given directory- Parameters:
pStream
- theInputStream
to read frompTempBaseName
- optional base name for the temporary filepTempDir
- optional temp directory- Throws:
java.io.IOException
- if the temporary file cannot be created, or cannot be opened for random access.
-
-
Method Detail
-
isCachedMemory
public final boolean isCachedMemory()
Description copied from interface:Seekable
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards, and the cache is kept in main memory. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.- Specified by:
isCachedMemory
in interfaceSeekable
- Returns:
true
if thisSeekable
caches data in main memory.- See Also:
Seekable.isCached()
,Seekable.isCachedFile()
-
isCachedFile
public final boolean isCachedFile()
Description copied from interface:Seekable
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.- Specified by:
isCachedFile
in interfaceSeekable
- Returns:
true
if thisSeekable
caches data in a temporary file.- See Also:
Seekable.isCached()
,Seekable.isCachedMemory()
-
closeImpl
protected void closeImpl() throws java.io.IOException
- Throws:
java.io.IOException
-
read
public int read() throws java.io.IOException
- Throws:
java.io.IOException
-
read
public int read(byte[] pBytes, int pOffset, int pLength) throws java.io.IOException
- Throws:
java.io.IOException
-
getCache
protected final com.twelvemonkeys.io.AbstractCachedSeekableStream.StreamCache getCache()
-
available
public int available() throws java.io.IOException
- Overrides:
available
in classjava.io.InputStream
- Throws:
java.io.IOException
-
syncPosition
protected final void syncPosition() throws java.io.IOException
- Throws:
java.io.IOException
-
isCached
public final boolean isCached()
Description copied from interface:Seekable
Returns true if thisSeekable
stream caches data itself in order to allow seeking backwards. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.- Returns:
true
if thisSeekable
caches data.- See Also:
Seekable.isCachedMemory()
,Seekable.isCachedFile()
-
seekImpl
protected void seekImpl(long pPosition) throws java.io.IOException
- Specified by:
seekImpl
in classSeekableInputStream
- Throws:
java.io.IOException
-
flushBeforeImpl
protected void flushBeforeImpl(long pPosition)
Description copied from class:SeekableInputStream
Discards the initial portion of the stream prior to the indicated postion.- Specified by:
flushBeforeImpl
in classSeekableInputStream
- Parameters:
pPosition
- the position to flush to- See Also:
SeekableInputStream.flushBefore(long)
-
-