lenya/src/java/org/apache/lenya/cms/ant PublicationTask.java,1.1,1.2 StaticHTMLExporter.java,1.2,1.3

Update of /repository/lenya/src/java/org/apache/lenya/cms/ant
In directory erbium:/tmp/cvs-serv17534/src/java/org/apache/lenya/cms/ant

Modified Files:
	PublicationTask.java StaticHTMLExporter.java 
Log Message:
added javadocs

Index: PublicationTask.java
===================================================================
RCS file: /repository/lenya/src/java/org/apache/lenya/cms/ant/PublicationTask.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** PublicationTask.java	6 May 2003 18:22:32 -0000	1.1
--- PublicationTask.java	7 May 2003 17:10:29 -0000	1.2
***************
*** 13,18 ****
  
  /**
!  *
!  * @author  andreas
   */
  public abstract class PublicationTask
--- 13,19 ----
  
  /**
!  * Abstract base class for publication-dependent Ant tasks.
!  * It requires some project parameters that are set by the AntTask.
!  * @author  <a href="mailto:[email protected]"/>
   */
  public abstract class PublicationTask
***************
*** 23,34 ****
--- 24,44 ----
      }
      
+     /**
+      * Returns the publication directory.
+      */
      protected File getPublicationDirectory() {
          return new File(getProject().getProperty(AntTask.PUBLICATION_DIRECTORY));
      }
      
+     /**
+      * Returns the publication ID.
+      */
      protected String getPublicationId() {
          return getProject().getProperty(AntTask.PUBLICATION_ID);
      }
      
+     /**
+      * Returns the servlet context (e.g., <code>tomcat/webapp/lenya</code>)
+      */
      protected File getServletContext() {
          return new File(getProject().getProperty(AntTask.SERVLET_CONTEXT_PATH));

Index: StaticHTMLExporter.java
===================================================================
RCS file: /repository/lenya/src/java/org/apache/lenya/cms/ant/StaticHTMLExporter.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** StaticHTMLExporter.java	6 May 2003 20:45:53 -0000	1.2
--- StaticHTMLExporter.java	7 May 2003 17:10:29 -0000	1.3
***************
*** 15,19 ****
  
  /**
!  *
   * @author  andreas
   */
--- 15,19 ----
  
  /**
!  * Ant task that exports a set of HTML URIs as static HTML files.
   * @author  andreas
   */
***************
*** 27,30 ****
--- 27,33 ----
      private String serverURL;
      
+     /**
+      * Returns the server URL.
+      */
      protected URL getServer()
          throws MalformedURLException {
***************
*** 32,35 ****
--- 35,41 ----
      }
      
+     /**
+      * Sets the server URL.
+      */
      public void setServer(String serverURL) {
          this.serverURL = serverURL;
***************
*** 38,45 ****
--- 44,57 ----
      private String path;
      
+     /**
+      * Returns the path to the exported files.
+      */
      protected String getPath() {
          return path;
      }
      
+     /**
+      * Sets the path to the exported files.
+      */
      public void setPath(String path) {
          this.path = path;
***************
*** 48,55 ****
--- 60,73 ----
      private String uris;
      
+     /**
+      * Returns the URIs to export.
+      */
      protected String[] getUris() {
          return uris.split(",");
      }
      
+     /**
+      * Sets the URIs to export.
+      */
      public void setUris(String uris) {
          this.uris = uris;
***************
*** 57,65 ****
      
      private String expression;
!     
      protected String getExpression() {
          return expression;
      }
      
      public void setExpression(String expression) {
          this.expression = expression;
--- 75,89 ----
      
      private String expression;
! 
!     /**
!      * Returns the expression in the URI to be replaced.
!      */
      protected String getExpression() {
          return expression;
      }
      
+     /**
+      * Sets the expression in the URI to be replaced.
+      */
      public void setExpression(String expression) {
          this.expression = expression;
***************
*** 68,79 ****
--- 92,118 ----
      private String replacement;
      
+     /**
+      * Returns the string in the URI that replaces the expression.
+      */
      protected String getReplacement() {
          return replacement;
      }
      
+     /**
+      * Sets the string in the URI that replaces the expression.
+      */
      public void setReplacement(String replacement) {
          this.replacement = replacement;
      }
      
+     /**
+      * Exports a set of URIs as a HTML file.
+      * @param serverURI The server to download the file from.
+      * @param publicationDirectory The directory of the publication.
+      * @param exportPath The path to export the files to (relative to publicationDirectory).
+      * @param uris The URIs to export (relative to the publication URI).
+      * @param substituteExpression A part of the complete URIs to be substituted.
+      * @param substituteReplacement A string to replace substituteExpression.
+      */
      public void export(URL serverURI, File publicationDirectory, String exportPath,
          String[] uris, String substituteExpression, String substituteReplacement)
***************
*** 107,110 ****
--- 146,152 ----
      }
      
+     /**
+      * Executes the task.
+      */
      public void execute()
          throws BuildException {