- java.lang.Object
-
- javax.imageio.stream.ImageInputStreamImpl
-
- javax.imageio.stream.ImageOutputStreamImpl
-
- javax.imageio.stream.FileCacheImageOutputStream
-
- All Implemented Interfaces:
Closeable,DataInput,DataOutput,AutoCloseable,ImageInputStream,ImageOutputStream
public class FileCacheImageOutputStream extends ImageOutputStreamImpl
An implementation ofImageOutputStreamthat writes its output to a regularOutputStream. A file is used to cache data until it is flushed to the output stream.
-
-
Field Summary
-
Fields declared in class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
-
-
Constructor Summary
Constructors Constructor Description FileCacheImageOutputStream(OutputStream stream, File cacheDir)Constructs aFileCacheImageOutputStreamthat will write to a givenoutputStream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes thisFileCacheImageOutputStream.booleanisCached()Returnstruesince thisImageOutputStreamcaches data in order to allow seeking backwards.booleanisCachedFile()Returnstruesince thisImageOutputStreammaintains a file cache.booleanisCachedMemory()Returnsfalsesince thisImageOutputStreamdoes not maintain a main memory cache.voidseek(long pos)Sets the current stream position and resets the bit offset to 0.-
Methods declared in class javax.imageio.stream.ImageOutputStreamImpl
flushBits
-
Methods declared in class javax.imageio.stream.ImageInputStreamImpl
checkClosed, finalize, length, mark, read, read, read, reset, skipBytes, skipBytes
-
Methods declared in class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods declared in interface javax.imageio.stream.ImageInputStream
flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, length, mark, read, read, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, setBitOffset, setByteOrder, skipBytes, skipBytes
-
Methods declared in interface javax.imageio.stream.ImageOutputStream
flushBefore, write, write, write, writeBit, writeBits, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeChars, writeDouble, writeDoubles, writeFloat, writeFloats, writeInt, writeInts, writeLong, writeLongs, writeShort, writeShorts, writeUTF
-
-
-
-
Constructor Detail
-
FileCacheImageOutputStream
public FileCacheImageOutputStream(OutputStream stream, File cacheDir) throws IOException
Constructs aFileCacheImageOutputStreamthat will write to a givenoutputStream.A temporary file is used as a cache. If
cacheDiris non-nulland is a directory, the file will be created there. If it isnull, the system-dependent default temporary-file directory will be used (see the documentation forFile.createTempFilefor details).- Parameters:
stream- anOutputStreamto write to.cacheDir- aFileindicating where the cache file should be created, ornullto use the system directory.- Throws:
IllegalArgumentException- ifstreamisnull.IllegalArgumentException- ifcacheDiris non-nullbut is not a directory.IOException- if a cache file cannot be created.
-
-
Method Detail
-
seek
public void seek(long pos) throws IOExceptionSets the current stream position and resets the bit offset to 0. It is legal to seek past the end of the file; anEOFExceptionwill be thrown only if a read is performed. The file length will not be increased until a write is performed.- Parameters:
pos- alongcontaining the desired file pointer position.- Throws:
IndexOutOfBoundsException- ifposis smaller than the flushed position.IOException- if any other I/O error occurs.
-
isCached
public boolean isCached()
Returnstruesince thisImageOutputStreamcaches data in order to allow seeking backwards.- Specified by:
isCachedin interfaceImageInputStream- Overrides:
isCachedin classImageInputStreamImpl- Returns:
true.- See Also:
isCachedMemory(),isCachedFile()
-
isCachedFile
public boolean isCachedFile()
Returnstruesince thisImageOutputStreammaintains a file cache.- Specified by:
isCachedFilein interfaceImageInputStream- Overrides:
isCachedFilein classImageInputStreamImpl- Returns:
true.- See Also:
isCached(),isCachedMemory()
-
isCachedMemory
public boolean isCachedMemory()
Returnsfalsesince thisImageOutputStreamdoes not maintain a main memory cache.- Specified by:
isCachedMemoryin interfaceImageInputStream- Overrides:
isCachedMemoryin classImageInputStreamImpl- Returns:
false.- See Also:
isCached(),isCachedFile()
-
close
public void close() throws IOExceptionCloses thisFileCacheImageOutputStream. All pending data is flushed to the output, and the cache file is closed and removed. The destinationOutputStreamis not closed.- Throws:
IOException- if an error occurs.
-
-