comment about reader behaviour

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194700 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/org/apache/fop/image/analyser/ImageReader.java b/src/org/apache/fop/image/analyser/ImageReader.java
index 7460a5b2240045648cef49de0ecb0acea7aea2e1..c1a5ac285558cdf6c77b083eb0522c1a216df664 100644 (file)
--- 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