svn commit: r1087485 - /tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java

[hl...@apache.org]

Author: hlship
Date: Thu Mar 31 23:15:24 2011
New Revision: 1087485

URL: http://svn.apache.org/viewvc?rev=1087485&view=rev
Log:
TAP5-73: Flesh out documentation of ResourceTransformer

Modified:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java?rev=1087485&r1=1087484&r2=1087485&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/ResourceTransformer.java Thu Mar 31 23:15:24 2011
@@ -17,7 +17,22 @@ package org.apache.tapestry5.services.as
 import java.io.IOException;
 import java.io.InputStream;
 
+/**
+ * A transformer is used to read a resource and pass it through a transformation stage, to get a
+ * stream that can be used on the client side. Examples of this are languages that "compile" to
+ * JavaScript, or any of a few higher-level versions of CSS that are compiled to standard CSS.
+ * 
+ * @since 5.3.0
+ */
 public interface ResourceTransformer
 {
+    /**
+     * Read the source input stream and provide a new input stream of the transformed content.
+     * 
+     * @param source
+     *            input content
+     * @return stream of output content
+     * @throws IOException
+     */
     InputStream transform(InputStream source) throws IOException;
 }