Author: sebb
Date: Mon Mar 30 20:35:08 2009
New Revision: 760159
URL: http://svn.apache.org/viewvc?rev=760159&view=rev
Log:
Javadoc
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java?rev=760159&r1=760158&r2=760159&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
Mon Mar 30 20:35:08 2009
@@ -36,6 +36,16 @@
private final byte[] oneByte = new byte[1];
static final int BYTE_MASK = 0xFF;
+ // Methods specific to ArchiveOutputStream
+
+ /**
+ * Writes the headers for an archive entry to the output stream.
+ * The caller must then write the content to the stream and call
+ * {...@link #closeArchiveEntry()} to complete the process.
+ *
+ * @param entry describes the entry
+ * @throws IOException
+ */
public abstract void putArchiveEntry(ArchiveEntry entry) throws
IOException;
/**
