svn commit: r231215 - /xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java

[je...@apache.org]

Author: jeremias
Date: Wed Aug 10 05:04:16 2005
New Revision: 231215

URL: http://svn.apache.org/viewcvs?rev=231215&view=rev
Log:
Better documentation of FOUserAgent.getStream()

Modified:
    xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java

Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java?rev=231215&r1=231214&r2=231215&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FOUserAgent.java Wed Aug 10 05:04:16 2005
@@ -410,21 +410,23 @@
 
 
     /**
-     * Get an input stream for a reference.
-     * Temporary solution until API better.
+     * Get an input stream for a reference. Subclass FOUserAgent and override this method to
+     * do custom URI to InputStream resolution.
+     * Temporary solution until the API is better.
      * @param uri URI to access
      * @return InputStream for accessing the resource.
      * @throws IOException in case of an I/O problem
      */
     public InputStream getStream(String uri) throws IOException {
+        //The default implementation does noting. Subclass FOUserAgent to add custom behaviour.
         return null;
     }
 
     /**
      * Sets the output File.
-     * @param the output File
+     * @param f the output File
      */
-    public void setOutputFile(File f){
+    public void setOutputFile(File f) {
         this.outputFile = f;
     }
 



---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org