svn commit: r766452 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java

[gr...@apache.org]

Author: grobmeier
Date: Sun Apr 19 11:28:24 2009
New Revision: 766452

URL: http://svn.apache.org/viewvc?rev=766452&view=rev
Log:
added javadocs

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java?rev=766452&r1=766451&r2=766452&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetResults.java Sun Apr 19 11:28:24 2009
@@ -29,39 +29,61 @@
     private List addedFromStream = new ArrayList();
     private List deleted = new ArrayList();
     
+    /**
+     * Adds the filename of a recently deleted file to the result list.
+     * @param fileName the file which has been deleted
+     */
     void deleted(String fileName) {
         deleted.add(fileName);
     }
     
+    /**
+     * Adds the name of a file to the result list which has been 
+     * copied from the source stream to the target stream.
+     * @param fileName the file name which has been added from the original stream
+     */
     void addedFromStream(String fileName) {
         addedFromStream.add(fileName);
     }
     
+    /**
+     * Adds the name of a file to the result list which has been
+     * copied from the changeset to the target stream
+     * @param fileName the name of the file
+     */
     void addedFromChangeSet(String fileName) {
         addedFromChangeSet.add(fileName);
     }
 
     /**
-     * @return the addedFromChangeSet
+     * Returns a list of filenames which has been added from the changeset
+     * @return the list of filenames
      */
     public List getAddedFromChangeSet() {
         return addedFromChangeSet;
     }
 
     /**
-     * @return the addedFromStream
+     * Returns a list of filenames which has been added from the original stream
+     * @return the list of filenames
      */
     public List getAddedFromStream() {
         return addedFromStream;
     }
 
     /**
-     * @return the deleted
+     * Returns a list of filenames which has been deleted
+     * @return the list of filenames
      */
     public List getDeleted() {
         return deleted;
     }
     
+    /**
+     * Checks if an filename already has been added to the result list
+     * @param filename the filename to check
+     * @return true, if this filename already has been added
+     */
     boolean hasBeenAdded(String filename) {
         if(addedFromChangeSet.contains(filename) || addedFromStream.contains(filename)) {
             return true;