[jboss-svn-commits] JBoss Common SVN: r3938 - shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api.

[jboss-svn-commits at lists.jboss.org]

Author: ALRubinger
Date: 2010-01-20 17:41:30 -0500 (Wed, 20 Jan 2010)
New Revision: 3938

Modified:
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Asset.java
Log:
[SHRINKWRAP-104] Document Asset to include the notion of no content; just an empty logical Path

Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Asset.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Asset.java	2010-01-20 21:51:34 UTC (rev 3937)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Asset.java	2010-01-20 22:41:30 UTC (rev 3938)
@@ -19,8 +19,9 @@
 import java.io.InputStream;
 
 /**
- * Represents a Class, file, or any other collection
- * of bytes stored under some context within an {@link Archive} 
+ * Represents content 
+ * stored under some context (a {@link ArchivePath})
+ * within an {@link Archive} 
  * 
  * @author <a href="mailto:aslak at conduct.no">Aslak Knutsen</a>
  * @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
@@ -30,8 +31,12 @@
    /**
     * Get a input stream for the resource content.
     * The caller is responsible for closing the stream. 
+    * If this returns null, this denotes that the {@link Asset}
+    * is to be viewed as a logical path (placeholder/directory) 
+    * only with no backing content.
     * 
-    * @return A new open inputstream for each call.
+    * @return A new open {@link InputStream} for each call, or null if this
+    * type simply represents a logical path within an {@link Archive}
     */
    InputStream openStream();
 }