You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2013/03/15 00:09:18 UTC
[6/14] git commit: Improve StreamableResource documentation
Improve StreamableResource documentation
Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/680fd2b0
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/680fd2b0
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/680fd2b0
Branch: refs/heads/master
Commit: 680fd2b0e6dc93c45f30595adbd274bb5fffd339
Parents: 56a6aa3
Author: Howard M. Lewis Ship <hl...@apache.org>
Authored: Fri Mar 8 16:21:10 2013 -0800
Committer: Howard M. Lewis Ship <hl...@apache.org>
Committed: Thu Mar 14 13:41:11 2013 -0700
----------------------------------------------------------------------
.../services/assets/StreamableResource.java | 7 +++++--
1 files changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/680fd2b0/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/StreamableResource.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/StreamableResource.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/StreamableResource.java
index 810e6d3..cb5e891 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/StreamableResource.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/StreamableResource.java
@@ -21,7 +21,10 @@ import java.io.InputStream;
import java.io.OutputStream;
/**
- * An object, derived from a {@link Resource}, that can be streamed (ultimately, to a client web browser).
+ * An object, derived from a {@link Resource}, that can be streamed (ultimately, to a client web browser). In addition,
+ * a StreamableResource may be transformed (by the stack of interceptors around {@link StreamableResourceSource}: this
+ * includes transforming a Resource (example: CoffeeScript to JavaScript compilation), as well as aggregation
+ * and compression.
*
* @since 5.3
*/
@@ -39,7 +42,7 @@ public interface StreamableResource
CompressionStatus getCompression();
/**
- * Returns the MIME content type, e.g., "image/jpeg".
+ * Returns the MIME content type, for example, "image/jpeg".
*/
String getContentType();