svn commit: r397054 - /maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java

[ca...@apache.org]

Author: carlos
Date: Tue Apr 25 19:17:33 2006
New Revision: 397054

URL: http://svn.apache.org/viewcvs?rev=397054&view=rev
Log:
Added javadocs

Modified:
    maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java

Modified: maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java
URL: http://svn.apache.org/viewcvs/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java?rev=397054&r1=397053&r2=397054&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java (original)
+++ maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java Tue Apr 25 19:17:33 2006
@@ -23,6 +23,9 @@
 import java.util.Arrays;
 
 /**
+ * Set of files used for SCM operations.
+ * Consists of the base directory of the files and a list of files relative to that directory.
+ * 
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id$
  */
@@ -39,16 +42,37 @@
 
     private static final File[] EMPTY_FILE_ARRAY = new File[0];
 
+    /**
+     * Create a file set with no files, only the base directory.
+     * 
+     * @param basedir directory files in the set are relative to
+     */
     public ScmFileSet( File basedir )
     {
         this( basedir, EMPTY_FILE_ARRAY );
     }
 
+    /**
+     * Create a file set with only the file provided, relative to basedir.
+     * 
+     * @param basedir directory file is relative to
+     * @param file file that the set will contain, has to be relative to basedir 
+     */
     public ScmFileSet( File basedir, File file )
     {
         this( basedir, new File[]{file} );
     }
 
+    /**
+     * Create a file set with only files (not directories) from basefile,
+     * using includes and excludes provided.
+     * 
+     * @param basedir directory files are relative to
+     * @param includes Ant pattern for files to include 
+     * @param excludes Ant pattern for files to exclude,
+     *        if null DEFAULT_EXCLUDES is used, else DEFAULT_EXCLUDES is added.
+     * @throws IOException
+     */
     public ScmFileSet( File basedir, String includes, String excludes )
         throws IOException
     {
@@ -67,6 +91,14 @@
         files = (File[]) FileUtils.getFiles( basedir, includes, excludes, false ).toArray( EMPTY_FILE_ARRAY );
     }
 
+    /**
+     * Create a file set with the files provided, relative to basedir.
+     * 
+     * @deprecated use ScmFileSet( File, List )
+     * 
+     * @param basedir directory files are relative to
+     * @param files files that the set will contain, have to be relative to basedir 
+     */
     public ScmFileSet( File basedir, File[] files )
     {
         if ( basedir == null )
@@ -83,11 +115,22 @@
         this.files = files;
     }
 
+    /**
+     * Get the base directory of the file set. It's the directory files in the set are relative to.
+     * @return
+     */
     public File getBasedir()
     {
         return basedir;
     }
 
+    /**
+     * Get the list of files in the set, relative to basedir
+     * 
+     * @deprecated use getFileList() instead
+     * 
+     * @return
+     */
     public File[] getFiles()
     {
         return this.files;