Author: markt
Date: Thu Sep 13 09:21:57 2012
New Revision: 1384249
URL: http://svn.apache.org/viewvc?rev=1384249&view=rev
Log:
Add some documentation.
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java?rev=1384249&r1=1384248&r2=1384249&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
Thu Sep 13 09:21:57 2012
@@ -29,6 +29,9 @@ import org.apache.catalina.WebResourceSe
import org.apache.catalina.util.IOTools;
import org.apache.catalina.util.ResourceSet;
+/**
+ * Represents a {@link WebResourceSet} based on a directory.
+ */
public class DirResourceSet implements WebResourceSet {
private static final String[] EMPTY_STRING_ARRAY = new String[0];
@@ -37,6 +40,21 @@ public class DirResourceSet implements W
private final File base;
private final String webAppMount;
+ /**
+ * Creates a new {@link WebResourceSet} based on a directory.
+ *
+ * @param root The {@link WebResourceRoot} this new
+ * {@link WebResourceSet} will be added to.
+ * @param base The directory on the file system from which the
+ * resources will be served.
+ * @param webAppMount The path within the web application at which this
+ * {@link WebResourceSet} will be mounted. For
+ * example, to add a directory of JARs to a web
+ * application, the directory would be mounted at
+ * "WEB-INF/lib/"
+ * @param internalPath The path within this new {@link WebResourceSet}
+ * where resources will be served from.
+ */
public DirResourceSet(WebResourceRoot root, File base, String webAppMount,
String internalPath) {
this.root = root;
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java?rev=1384249&r1=1384248&r2=1384249&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
Thu Sep 13 09:21:57 2012
@@ -30,6 +30,9 @@ import org.apache.catalina.WebResourceRo
import org.apache.catalina.WebResourceSet;
import org.apache.catalina.util.ResourceSet;
+/**
+ * Represents a {@link WebResourceSet} based on a JAR file.
+ */
public class JarResourceSet implements WebResourceSet {
private final WebResourceRoot root;
@@ -38,6 +41,19 @@ public class JarResourceSet implements W
private final String webAppMount;
private final String internalPath;
+ /**
+ * Creates a new {@link WebResourceSet} based on a JAR file.
+ *
+ * @param root The {@link WebResourceRoot} this new
+ * {@link WebResourceSet} will be added to.
+ * @param base The JAR file on the file system from which the
+ * resources will be served.
+ * @param webAppMount The path within the web application at which this
+ * {@link WebResourceSet} will be mounted.
+ * @param internalPath The path within this new {@link WebResourceSet}
+ * where resources will be served from. E.g. for a
+ * resource JAR, this would be
"META-INF/resources"
+ */
public JarResourceSet(WebResourceRoot root, File base, String webAppMount,
String internalPath) throws IllegalArgumentException {
this.root = root;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
