commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r759630 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
Date Sun, 29 Mar 2009 02:01:37 GMT
Author: sebb
Date: Sun Mar 29 02:01:36 2009
New Revision: 759630

URL: http://svn.apache.org/viewvc?rev=759630&view=rev
Log:
Javadoc

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

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java?rev=759630&r1=759629&r2=759630&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
(original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
Sun Mar 29 02:01:36 2009
@@ -26,11 +26,13 @@
  * @Immutable
  */
 public class Change {
-	private final String targetFile;
-	private final ArchiveEntry entry;
-	private final InputStream input;
-	private final int type;
+	private final String targetFile; // entry name to delete
+	private final ArchiveEntry entry; // new entry to add
+	private final InputStream input; // source for new entry
 	
+	// Type of change
+	private final int type;
+	// Possible type values
 	static final int TYPE_DELETE = 1;
 	static final int TYPE_ADD = 2;
 	static final int TYPE_MOVE = 3; // NOT USED
@@ -59,6 +61,12 @@
 //		type = TYPE_MOVE;
 //	}
 	
+	/**
+	 * Construct a change which adds an entry.
+	 * 
+	 * @param pEntry the entry details
+	 * @param pInput the InputStream for the entry data
+	 */
 	public Change(final ArchiveEntry pEntry, final InputStream pInput) {
 		if(pEntry == null || pInput == null) {
 			throw new NullPointerException();



Mime
View raw message