| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <TITLE> |
| StreamRegistryEntry (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="StreamRegistryEntry (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/StreamRegistryEntry.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"> |
| <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/URLRegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi"><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/spi/StreamRegistryEntry.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StreamRegistryEntry.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.spi</FONT> |
| <BR> |
| Interface StreamRegistryEntry</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi">RegistryEntry</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/apache/batik/ext/awt/image/codec/imageio/AbstractImageIORegistryEntry.html" title="class in org.apache.batik.ext.awt.image.codec.imageio">AbstractImageIORegistryEntry</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/codec/imageio/ImageIOJPEGRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.codec.imageio">ImageIOJPEGRegistryEntry</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/codec/imageio/ImageIOPNGRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.codec.imageio">ImageIOPNGRegistryEntry</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/codec/imageio/ImageIOTIFFRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.codec.imageio">ImageIOTIFFRegistryEntry</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/MagicNumberRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.spi">MagicNumberRegistryEntry</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/codec/png/PNGRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.codec.png">PNGRegistryEntry</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>StreamRegistryEntry</B><DT>extends <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi">RegistryEntry</A></DL> |
| </PRE> |
| |
| <P> |
| This type of Image tag registy entry is used for most normal image |
| file formats. You are given a markable stream and an opportunity |
| to check if it is "compatible" if you return true then you will |
| likely be asked to provide the decoded image next. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/MagicNumberRegistryEntry.html" title="class in org.apache.batik.ext.awt.image.spi"><CODE>MagicNumberRegistryEntry</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/StreamRegistryEntry.html#getReadlimit()">getReadlimit</A></B>()</CODE> |
| |
| <BR> |
| returns the number of bytes that need to be |
| supported by mark on the InputStream for this |
| to check the stream for compatibility.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html" title="interface in org.apache.batik.ext.awt.image.renderable">Filter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/StreamRegistryEntry.html#handleStream(java.io.InputStream, org.apache.batik.util.ParsedURL, boolean)">handleStream</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> is, |
| <A HREF="../../../../../../../org/apache/batik/util/ParsedURL.html" title="class in org.apache.batik.util">ParsedURL</A> origURL, |
| boolean needRawData)</CODE> |
| |
| <BR> |
| Decode the Stream into a Filter.</TD> |
| </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/spi/StreamRegistryEntry.html#isCompatibleStream(java.io.InputStream)">isCompatibleStream</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> is)</CODE> |
| |
| <BR> |
| Check if the Stream references an image that can be handled by |
| this format handler.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.batik.ext.awt.image.spi.RegistryEntry"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.batik.ext.awt.image.spi.<A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi">RegistryEntry</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html#getFormatName()">getFormatName</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html#getMimeTypes()">getMimeTypes</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html#getPriority()">getPriority</A>, <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html#getStandardExtensions()">getStandardExtensions</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="getReadlimit()"><!-- --></A><H3> |
| getReadlimit</H3> |
| <PRE> |
| int <B>getReadlimit</B>()</PRE> |
| <DL> |
| <DD>returns the number of bytes that need to be |
| supported by mark on the InputStream for this |
| to check the stream for compatibility. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isCompatibleStream(java.io.InputStream)"><!-- --></A><H3> |
| isCompatibleStream</H3> |
| <PRE> |
| boolean <B>isCompatibleStream</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> is) |
| throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/StreamCorruptedException.html?is-external=true" title="class or interface in java.io">StreamCorruptedException</A></PRE> |
| <DL> |
| <DD>Check if the Stream references an image that can be handled by |
| this format handler. The input stream passed in should be |
| assumed to support mark and reset. |
| |
| If this method throws a StreamCorruptedException then the |
| InputStream will be closed and a new one opened (if possible). |
| |
| This method should only throw a StreamCorruptedException if it |
| is unable to restore the state of the InputStream |
| (i.e. mark/reset fails basically). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/StreamCorruptedException.html?is-external=true" title="class or interface in java.io">StreamCorruptedException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="handleStream(java.io.InputStream, org.apache.batik.util.ParsedURL, boolean)"><!-- --></A><H3> |
| handleStream</H3> |
| <PRE> |
| <A HREF="../../../../../../../org/apache/batik/ext/awt/image/renderable/Filter.html" title="interface in org.apache.batik.ext.awt.image.renderable">Filter</A> <B>handleStream</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> is, |
| <A HREF="../../../../../../../org/apache/batik/util/ParsedURL.html" title="class in org.apache.batik.util">ParsedURL</A> origURL, |
| boolean needRawData)</PRE> |
| <DL> |
| <DD>Decode the Stream into a Filter. If the stream turns out not to |
| be of a format this RegistryEntry can handle you should attempt |
| to reset the stream, then return null.<P> |
| |
| This should only return a broken link image when the image is |
| clearly of this format, but is unreadable for some reason. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>is</CODE> - The input stream that contains the image.<DD><CODE>origURL</CODE> - The original URL, if any, for documentation |
| purposes only. This may be null.<DD><CODE>needRawData</CODE> - If true the image returned should not have |
| any default color correction the file may |
| specify applied.</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/StreamRegistryEntry.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"> |
| <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/RegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/batik/ext/awt/image/spi/URLRegistryEntry.html" title="interface in org.apache.batik.ext.awt.image.spi"><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/spi/StreamRegistryEntry.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StreamRegistryEntry.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
