Merge upstream branch 'master' from https://github.com/iipc/webarchive-commons

- updates version number to 1.1.11-SNAPSHOT
- keep commons-io version at 2.11.0 to stay in sync with version
  Hadoop depends on

Author: sebastian-nagel

pom.xml

@@ -9,7 +9,7 @@
 
   <groupId>org.commoncrawl</groupId>
   <artifactId>ia-web-commons</artifactId>
-  <version>1.1.10-SNAPSHOT</version>
+  <version>1.1.11-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>ia-web-commons</name>
@@ -137,7 +137,7 @@
     <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
-      <version>2.8.0</version>
+      <version>2.11.0</version>
     </dependency>
 
     <dependency>

src/main/java/org/archive/format/gzip/GZIPStaticHeader.java

@@ -13,7 +13,7 @@
  * @author Brad
  * 
  * +---+---+---+---+---+---+---+---+---+---+
- * |ID1|ID2|CM |FLG|     MTIME     |XFL|OS | (more-->)
+ * |ID1|ID2|CM |FLG|     MTIME     |XFL|OS | (more-->)
  * +---+---+---+---+---+---+---+---+---+---+
  */
 public class GZIPStaticHeader implements GZIPConstants {

src/main/java/org/archive/format/gzip/zipnum/MultiBlockIterator.java

@@ -18,7 +18,7 @@ public class MultiBlockIterator extends AbstractPeekableIterator<String> {
 	private CloseableIterator<CloseableIterator<String>> blockItr = null;
 
 	/**
-	 * @param blocks which should be fetched and unzipped, one after another
+	 * @param blockItr blocks which should be fetched and unzipped, one after another
 	 */
 	public MultiBlockIterator(CloseableIterator<CloseableIterator<String>> blockItr) {
 		this.blockItr = blockItr;

src/main/java/org/archive/format/text/charset/CharsetDetector.java

@@ -139,7 +139,6 @@ protected String contentTypeToCharset(final String contentType) {
 	 * Attempt to divine the character encoding of the document from the 
 	 * Content-Type HTTP header (with a "charset=")
 	 * 
-	 * @param resource
 	 * @return String character set found or null if the header was not present
 	 * @throws IOException 
 	 */
@@ -161,7 +160,6 @@ protected String getCharsetFromHeaders(HttpHeaders headers)
 	 * Attempt to find a META tag in the HTML that hints at the character set
 	 * used to write the document.
 	 * 
-	 * @param resource
 	 * @return String character set found from META tags in the HTML
 	 * @throws IOException
 	 */
@@ -224,9 +222,7 @@ public static String findMetaContentType(String pageSample) {
 	 * Attempts to figure out the character set of the document using
 	 * the excellent juniversalchardet library.
 	 * 
-	 * @param resource
 	 * @return String character encoding found, or null if nothing looked good.
-	 * @throws IOException
 	 */
 	protected String getCharsetFromBytes(byte buffer[], int len) 
 	throws IOException {
@@ -242,9 +238,6 @@ protected String getCharsetFromBytes(byte buffer[], int len)
 	    return null;
 	}
 	/**
-	 * @param resource (presumably text) Resource to determine the charset
-	 * @param request WaybackRequest which may contain additional hints to
-	 *        processing
 	 * @return String charset name for the Resource
 	 * @throws IOException if there are problems reading the Resource
 	 */

src/main/java/org/archive/format/warc/WARCConstants.java

@@ -24,7 +24,7 @@
 /**
  * WARC Constants used by WARC readers and writers.
  * 
- * @contributor stack
+ * @author stack
  */
 public interface WARCConstants extends ArchiveFileConstants {
     /**
@@ -175,8 +175,8 @@ enum WARCRecordType {
     /**
      * These fields help a consumer of the warc to locate the warc record that
      * {@value #HEADER_KEY_REFERS_TO} refers to.
-     * 
-     * @see WARCWriterProcessor
+     * <p>
+     * See WARCWriterProcessor
      */
     public static final String HEADER_KEY_REFERS_TO_TARGET_URI = "WARC-Refers-To-Target-URI";
     public static final String HEADER_KEY_REFERS_TO_DATE = "WARC-Refers-To-Date";

src/main/java/org/archive/httpclient/package.html

@@ -7,16 +7,16 @@
 	apache <a href="http://jakarta.apache.org/commons/httpclient/">jakarta
 	commons httpclient</a>.
 
-	<h3>HttpRecorderGetMethod</h3>
+	<h2>HttpRecorderGetMethod</h2>
 	<p>Class that the passed HttpRecorder w/ boundary between
 	HTTP header and content.  Also forces a close on the response on
 	call to releaseConnection.</p>
 
-	<h3>ConfigurableTrustManagerProtocolSocketFactory</h3>
+	<h2>ConfigurableTrustManagerProtocolSocketFactory</h2>
 	<p>A protocol socket factory that allows setting of trust level on
 	construction.</p>
 
-    <h3>References</h3>
+    <h2>References</h2>
     <p><a
     href="http://java.sun.com/j2se/1.4.2/docs/guide/security/jsse/JSSERefGuide.html">JavaTM Secure Socket Extension (JSSE): Reference Guide</a></p>
 

src/main/java/org/archive/io/ArchiveReader.java

@@ -711,9 +711,7 @@ public boolean outputRecord(final String format)
 
     /**
      * Dump this file on STDOUT
-     * @throws compress True if dumped output is compressed.
-     * @throws IOException
-     * @throws java.text.ParseException
+     * @param compress True if dumped output is compressed.
      */
     public abstract void dump(final boolean compress)
     throws IOException, java.text.ParseException;

src/main/java/org/archive/io/GenericReplayCharSequence.java

@@ -45,13 +45,11 @@
 
 /**
  * (Replay)CharSequence view on recorded streams.
+ **
+ * <p>Call {@link #close()} on this class when done to clean up resources.
  *
- * For small streams, use {@link InMemoryReplayCharSequence}.
- *
- * <p>Call {@link close()} on this class when done to clean up resources.
- *
- * @contributor stack
- * @contributor nlevitt
+ * @author stack
+ * @author nlevitt
  * @version $Revision$, $Date$
  */
 public class GenericReplayCharSequence implements ReplayCharSequence {
@@ -67,7 +65,7 @@ public class GenericReplayCharSequence implements ReplayCharSequence {
      * decodings.  The name of the file that holds the decoding is the name
      * of the backing file w/ this encoding for a suffix.
      *
-     * <p>See <a ref="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Encoding</a>.
+     * <p>See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Encoding</a>.
      */
     public static final Charset WRITE_ENCODING = Charsets.UTF_16BE;
 

src/main/java/org/archive/io/MiserOutputStream.java

@@ -27,7 +27,7 @@
  * A filter stream that both counts bytes written, and optionally swallows 
  * flush() requests. 
  * 
- * @contributor gojomo
+ * @author gojomo
  */
 public class MiserOutputStream extends FilterOutputStream {
     protected long count;

src/main/java/org/archive/io/Preformatter.java

@@ -24,7 +24,7 @@
  * Interface indicating a logging Formatter can preformat a record (outside
  * the standard-implementation synchronized block) and cache it, returning it
  * for the next request for formatting from the same thread. 
- * @contributor gojomo
+ * @author gojomo
  */
 public interface Preformatter {
     public void preformat(LogRecord record);