Predominantly clean up and javadocs, very little functional change here

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

1 files changed, 19 insertions, 0 deletions

diff --git a/src/java/org/apache/fop/apps/io/ResourceResolver.java b/src/java/org/apache/fop/apps/io/ResourceResolver.java
index 3d20aaebc..a3a9cf0c3 100644
--- a/src/java/org/apache/fop/apps/io/ResourceResolver.java
+++ b/src/java/org/apache/fop/apps/io/ResourceResolver.java
@@ -23,10 +23,29 @@ import java.io.IOException;
 import java.io.OutputStream;
 import java.net.URI;
 
+/**
+ * Implementations of this resource resolver allow FOP users to control the URI resolution
+ * mechanism. All resource and output stream acquisition goes through this when its implementation
+ * is given to the {@link org.apache.fop.apps.EnvironmentProfile}.
+ */
 public interface ResourceResolver {
 
+    /**
+     * Get a resource given the URI pointing to said resource.
+     *
+     * @param uri the resource URI
+     * @return the resource
+     * @throws IOException if an I/O error occured during resource acquisition
+     */
     Resource getResource(URI uri) throws IOException;
 
+    /**
+     * Gets an output stream of a given URI.
+     *
+     * @param uri the output stream URI
+     * @return the output stream
+     * @throws IOException if an I/O error occured while creating an output stream
+     */
     OutputStream getOutputStream(URI uri) throws IOException;
 
 }