dlr 02/01/18 14:06:48
Modified: src/java/org/apache/stratum/resources ResourceManager.java
Log:
Added basic JavaDoc.
Revision Changes Path
1.2 +16 -2
jakarta-turbine-stratum/src/java/org/apache/stratum/resources/ResourceManager.java
Index: ResourceManager.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-stratum/src/java/org/apache/stratum/resources/ResourceManager.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- ResourceManager.java 15 Jan 2002 04:59:27 -0000 1.1
+++ ResourceManager.java 18 Jan 2002 22:06:48 -0000 1.2
@@ -1,8 +1,22 @@
package org.apache.stratum.resources;
-/* Generated by Together */
-
+/**
+ * This class is responsible for managing {@link
+ * org.apache.stratum.resources.Resource} objects -- use it whenever
+ * you need a handle one (rather than instantiating one directly).
+ *
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
+ */
public interface ResourceManager
{
+ /**
+ * Interface for acquiring handles to various resources.
+ *
+ * @param resourceName The name of the resource to retrieve.
+ * @param encoding The encoding to use.
+ * @return The resource (or possibly <code>null</code> if not
+ * found).
+ */
Resource getResource(String resourceName, String encoding);
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
