aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/image/analyser/ImageReader.java
diff options
context:
space:
mode:
authorKeiron Liddle <keiron@apache.org>2002-03-11 13:01:24 +0000
committerKeiron Liddle <keiron@apache.org>2002-03-11 13:01:24 +0000
commitc2dcd45c6305d928c21b2773d8840a1ee9df3c43 (patch)
treed6d9d61ccc2917ab0af6cb70dc23d0f85f4f6fbb /src/org/apache/fop/image/analyser/ImageReader.java
parentfa70e1de28a17ff839318a4dfcc5504d27dc1d7f (diff)
downloadxmlgraphics-fop-c2dcd45c6305d928c21b2773d8840a1ee9df3c43.tar.gz
xmlgraphics-fop-c2dcd45c6305d928c21b2773d8840a1ee9df3c43.zip
comment about reader behaviour
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194700 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/org/apache/fop/image/analyser/ImageReader.java')
-rw-r--r--src/org/apache/fop/image/analyser/ImageReader.java6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/org/apache/fop/image/analyser/ImageReader.java b/src/org/apache/fop/image/analyser/ImageReader.java
index 7460a5b22..c1a5ac285 100644
--- a/src/org/apache/fop/image/analyser/ImageReader.java
+++ b/src/org/apache/fop/image/analyser/ImageReader.java
@@ -23,6 +23,12 @@ public interface ImageReader {
/**
* Verify image type.
+ * If the stream does not contain image data expected by
+ * the reader it must reset the stream to the start. This
+ * is so that the next reader can start reading from the start.
+ * The reader must not close the stream unless it can handle
+ * the image and it has read the information.
+ *
* @param bis Image buffered input stream
* @return true if image type is the handled one
* @exception IOException io error