| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <TITLE> |
| FileCacheSeekableStream (Apache Batik Javadoc) |
| </TITLE> |
| |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FileCacheSeekableStream (Apache Batik Javadoc)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileCacheSeekableStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/ForwardSeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FileCacheSeekableStream.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.batik.ext.awt.image.codec.util.SeekableStream">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.batik.ext.awt.image.codec.util</FONT> |
| <BR> |
| Class FileCacheSeekableStream</H2> |
| <PRE> |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</A> |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">org.apache.batik.ext.awt.image.codec.util.SeekableStream</A> |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.batik.ext.awt.image.codec.util.FileCacheSeekableStream</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <B>FileCacheSeekableStream</B><DT>extends <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></DL> |
| </PRE> |
| |
| <P> |
| A subclass of <code>SeekableStream</code> that may be used to wrap |
| a regular <code>InputStream</code>. Seeking backwards is supported |
| by means of a file cache. In circumstances that do not allow the |
| creation of a temporary file (for example, due to security |
| consideration or the absence of local disk), the |
| <code>MemoryCacheSeekableStream</code> class may be used instead. |
| |
| <p> The <code>mark()</code> and <code>reset()</code> methods are |
| supported. |
| |
| <p><b> This class is not a committed part of the JAI API. It may |
| be removed or changed in future releases of JAI.</b> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.batik.ext.awt.image.codec.util.SeekableStream"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.batik.ext.awt.image.codec.util.<A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#markPos">markPos</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#FileCacheSeekableStream(java.io.InputStream)">FileCacheSeekableStream</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> stream)</CODE> |
| |
| <BR> |
| Constructs a <code>MemoryCacheSeekableStream</code> that takes |
| its source data from a regular <code>InputStream</code>.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#canSeekBackwards()">canSeekBackwards</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> since all |
| <code>FileCacheSeekableStream</code> instances support seeking |
| backwards.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Closes this stream and releases any system resources |
| associated with the stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#getFilePointer()">getFilePointer</A></B>()</CODE> |
| |
| <BR> |
| Returns the current offset in this file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#read()">read</A></B>()</CODE> |
| |
| <BR> |
| Reads the next byte of data from the input stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#read(byte[], int, int)">read</A></B>(byte[] b, |
| int off, |
| int len)</CODE> |
| |
| <BR> |
| Reads up to <code>len</code> bytes of data from the input stream into |
| an array of bytes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html#seek(long)">seek</A></B>(long pos)</CODE> |
| |
| <BR> |
| Sets the file-pointer offset, measured from the beginning of this |
| file, at which the next read occurs.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.batik.ext.awt.image.codec.util.SeekableStream"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.batik.ext.awt.image.codec.util.<A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#finalize()">finalize</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#mark(int)">mark</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#markSupported()">markSupported</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readBoolean()">readBoolean</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readByte()">readByte</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readChar()">readChar</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readCharLE()">readCharLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readDouble()">readDouble</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readDoubleLE()">readDoubleLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readFloat()">readFloat</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readFloatLE()">readFloatLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readFully(byte[])">readFully</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readFully(byte[], int, int)">readFully</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readInt()">readInt</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readIntLE()">readIntLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readLine()">readLine</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readLong()">readLong</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readLongLE()">readLongLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readShort()">readShort</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readShortLE()">readShortLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUnsignedByte()">readUnsignedByte</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUnsignedInt()">readUnsignedInt</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUnsignedIntLE()">readUnsignedIntLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUnsignedShort()">readUnsignedShort</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUnsignedShortLE()">readUnsignedShortLE</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#readUTF()">readUTF</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#reset()">reset</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#skipBytes(int)">skipBytes</A>, <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#wrapInputStream(java.io.InputStream, boolean)">wrapInputStream</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.io.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="FileCacheSeekableStream(java.io.InputStream)"><!-- --></A><H3> |
| FileCacheSeekableStream</H3> |
| <PRE> |
| public <B>FileCacheSeekableStream</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> stream) |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Constructs a <code>MemoryCacheSeekableStream</code> that takes |
| its source data from a regular <code>InputStream</code>. |
| Seeking backwards is supported by means of an file cache. |
| |
| <p> An <code>IOException</code> will be thrown if the |
| attempt to create the cache file fails for any reason. |
| <P> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="canSeekBackwards()"><!-- --></A><H3> |
| canSeekBackwards</H3> |
| <PRE> |
| public boolean <B>canSeekBackwards</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> since all |
| <code>FileCacheSeekableStream</code> instances support seeking |
| backwards. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#canSeekBackwards()">canSeekBackwards</A></CODE> in class <CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFilePointer()"><!-- --></A><H3> |
| getFilePointer</H3> |
| <PRE> |
| public long <B>getFilePointer</B>()</PRE> |
| <DL> |
| <DD>Returns the current offset in this file. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#getFilePointer()">getFilePointer</A></CODE> in class <CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the offset from the beginning of the file, in bytes, |
| at which the next read occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="seek(long)"><!-- --></A><H3> |
| seek</H3> |
| <PRE> |
| public void <B>seek</B>(long pos) |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Sets the file-pointer offset, measured from the beginning of this |
| file, at which the next read occurs. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#seek(long)">seek</A></CODE> in class <CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pos</CODE> - the offset position, measured in bytes from the |
| beginning of the file, at which to set the file |
| pointer. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if <code>pos</code> is less than |
| <code>0</code> or if an I/O error occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read()"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| public int <B>read</B>() |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Reads the next byte of data from the input stream. The value byte is |
| returned as an <code>int</code> in the range <code>0</code> to |
| <code>255</code>. If no byte is available because the end of the stream |
| has been reached, the value <code>-1</code> is returned. This method |
| blocks until input data is available, the end of the stream is detected, |
| or an exception is thrown. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#read()">read</A></CODE> in class <CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the next byte of data, or <code>-1</code> if the end of the |
| stream is reached. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(byte[], int, int)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| public int <B>read</B>(byte[] b, |
| int off, |
| int len) |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Reads up to <code>len</code> bytes of data from the input stream into |
| an array of bytes. An attempt is made to read as many as |
| <code>len</code> bytes, but a smaller number may be read, possibly |
| zero. The number of bytes actually read is returned as an integer. |
| |
| <p> This method blocks until input data is available, end of file is |
| detected, or an exception is thrown. |
| |
| <p> If <code>b</code> is <code>null</code>, a |
| <code>NullPointerException</code> is thrown. |
| |
| <p> If <code>off</code> is negative, or <code>len</code> is negative, or |
| <code>off+len</code> is greater than the length of the array |
| <code>b</code>, then an <code>IndexOutOfBoundsException</code> is |
| thrown. |
| |
| <p> If <code>len</code> is zero, then no bytes are read and |
| <code>0</code> is returned; otherwise, there is an attempt to read at |
| least one byte. If no byte is available because the stream is at end of |
| file, the value <code>-1</code> is returned; otherwise, at least one |
| byte is read and stored into <code>b</code>. |
| |
| <p> The first byte read is stored into element <code>b[off]</code>, the |
| next one into <code>b[off+1]</code>, and so on. The number of bytes read |
| is, at most, equal to <code>len</code>. Let <i>k</i> be the number of |
| bytes actually read; these bytes will be stored in elements |
| <code>b[off]</code> through <code>b[off+</code><i>k</i><code>-1]</code>, |
| leaving elements <code>b[off+</code><i>k</i><code>]</code> through |
| <code>b[off+len-1]</code> unaffected. |
| |
| <p> In every case, elements <code>b[0]</code> through |
| <code>b[off]</code> and elements <code>b[off+len]</code> through |
| <code>b[b.length-1]</code> are unaffected. |
| |
| <p> If the first byte cannot be read for any reason other than end of |
| file, then an <code>IOException</code> is thrown. In particular, an |
| <code>IOException</code> is thrown if the input stream has been closed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html#read(byte[], int, int)">read</A></CODE> in class <CODE><A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/SeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util">SeekableStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>b</CODE> - the buffer into which the data is read.<DD><CODE>off</CODE> - the start offset in array <code>b</code> |
| at which the data is written.<DD><CODE>len</CODE> - the maximum number of bytes to read. |
| <DT><B>Returns:</B><DD>the total number of bytes read into the buffer, or |
| <code>-1</code> if there is no more data because the end of |
| the stream has been reached. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>() |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Closes this stream and releases any system resources |
| associated with the stream. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE> in interface <CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE> in class <CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileCacheSeekableStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../../../org/apache/batik/ext/awt/image/codec/util/ForwardSeekableStream.html" title="class in org.apache.batik.ext.awt.image.codec.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/apache/batik/ext/awt/image/codec/util/FileCacheSeekableStream.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FileCacheSeekableStream.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.batik.ext.awt.image.codec.util.SeekableStream">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2017 <a href='http://www.apache.org/'>Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |