From 24ddbbabc190604af94d8dde2a2d0f557bff4c92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 3 Oct 2024 18:51:14 +0000 Subject: [PATCH 1/5] Bump commons-io:commons-io from 2.7 to 2.14.0 Bumps commons-io:commons-io from 2.7 to 2.14.0. --- updated-dependencies: - dependency-name: commons-io:commons-io dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 7181f0ac..f0c6ac73 100644 --- a/pom.xml +++ b/pom.xml @@ -150,7 +150,7 @@ commons-io commons-io - 2.7 + 2.14.0 From 74bc86ca1d594d530877cd896711f35dd7c4441d Mon Sep 17 00:00:00 2001 From: Alex Osborne Date: Tue, 15 Oct 2024 17:25:34 +0900 Subject: [PATCH 2/5] Fix javadoc build errors --- .../gzip/zipnum/MultiBlockIterator.java | 2 +- .../format/text/charset/CharsetDetector.java | 7 ------- .../archive/format/warc/WARCConstants.java | 6 +++--- .../java/org/archive/httpclient/package.html | 6 +++--- .../java/org/archive/io/ArchiveReader.java | 4 +--- .../archive/io/GenericReplayCharSequence.java | 12 +++++------ .../org/archive/io/MiserOutputStream.java | 2 +- .../java/org/archive/io/Preformatter.java | 2 +- .../org/archive/io/RecordingInputStream.java | 2 +- .../org/archive/io/ReplayInputStream.java | 6 +++--- .../archive/io/RepositionableInputStream.java | 2 +- src/main/java/org/archive/io/WriterPool.java | 3 --- .../java/org/archive/io/WriterPoolMember.java | 9 --------- .../java/org/archive/io/arc/ARCRecord.java | 6 ++---- .../java/org/archive/io/arc/ARCWriter.java | 7 +------ .../java/org/archive/io/warc/WARCWriter.java | 14 ++----------- .../org/archive/io/warc/WARCWriterPool.java | 4 ++-- .../java/org/archive/io/warc/package.html | 4 ++-- .../java/org/archive/net/PublicSuffixes.java | 2 +- .../org/archive/resource/ResourceFactory.java | 6 ------ .../org/archive/uid/RecordIDGenerator.java | 5 ++--- src/main/java/org/archive/uid/package.html | 4 ++-- src/main/java/org/archive/url/LaxURI.java | 4 ++-- src/main/java/org/archive/url/URLParser.java | 8 ++++---- .../org/archive/url/UsableURIFactory.java | 14 ++++++------- .../java/org/archive/util/ArchiveUtils.java | 20 ++++++------------- src/main/java/org/archive/util/ByteOp.java | 4 ++-- src/main/java/org/archive/util/DateUtils.java | 12 +++++------ src/main/java/org/archive/util/FileUtils.java | 6 +++--- src/main/java/org/archive/util/IAUtils.java | 2 +- .../archive/util/IterableLineIterator.java | 2 +- .../java/org/archive/util/LaxHttpParser.java | 6 +++--- .../java/org/archive/util/PropertyUtils.java | 5 ++--- src/main/java/org/archive/util/Recorder.java | 10 +++------- src/main/java/org/archive/util/Reporter.java | 2 +- .../java/org/archive/util/SurtPrefixSet.java | 3 +-- src/main/java/org/archive/util/TextUtils.java | 2 +- .../org/archive/util/anvl/ANVLRecord.java | 6 +++--- .../java/org/archive/util/anvl/package.html | 1 - .../util/binsearch/ByteBufferInputStream.java | 2 +- .../iterator/CloseableIteratorWrapper.java | 2 +- .../util/zip/GZIPMembersInputStream.java | 3 +-- .../util/zip/OpenJDK7GZIPInputStream.java | 4 ++-- .../util/zip/OpenJDK7InflaterInputStream.java | 4 ++-- .../java/org/archive/util/FileUtilsTest.java | 4 ++-- .../org/archive/util/PropertyUtilsTest.java | 2 +- .../util/zip/GZIPMembersInputStreamTest.java | 2 +- 47 files changed, 90 insertions(+), 155 deletions(-) diff --git a/src/main/java/org/archive/format/gzip/zipnum/MultiBlockIterator.java b/src/main/java/org/archive/format/gzip/zipnum/MultiBlockIterator.java index 05abbe1c..df2abd4d 100644 --- a/src/main/java/org/archive/format/gzip/zipnum/MultiBlockIterator.java +++ b/src/main/java/org/archive/format/gzip/zipnum/MultiBlockIterator.java @@ -18,7 +18,7 @@ public class MultiBlockIterator extends AbstractPeekableIterator { private CloseableIterator> 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> blockItr) { this.blockItr = blockItr; diff --git a/src/main/java/org/archive/format/text/charset/CharsetDetector.java b/src/main/java/org/archive/format/text/charset/CharsetDetector.java index 690f8b99..214fde07 100644 --- a/src/main/java/org/archive/format/text/charset/CharsetDetector.java +++ b/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 */ diff --git a/src/main/java/org/archive/format/warc/WARCConstants.java b/src/main/java/org/archive/format/warc/WARCConstants.java index 504dc380..72dad45a 100644 --- a/src/main/java/org/archive/format/warc/WARCConstants.java +++ b/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 + *

+ * 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"; diff --git a/src/main/java/org/archive/httpclient/package.html b/src/main/java/org/archive/httpclient/package.html index 87ae77ed..adca4891 100644 --- a/src/main/java/org/archive/httpclient/package.html +++ b/src/main/java/org/archive/httpclient/package.html @@ -7,16 +7,16 @@ apache jakarta commons httpclient. -

HttpRecorderGetMethod

+

HttpRecorderGetMethod

Class that the passed HttpRecorder w/ boundary between HTTP header and content. Also forces a close on the response on call to releaseConnection.

-

ConfigurableTrustManagerProtocolSocketFactory

+

ConfigurableTrustManagerProtocolSocketFactory

A protocol socket factory that allows setting of trust level on construction.

-

References

+

References

JavaTM Secure Socket Extension (JSSE): Reference Guide

diff --git a/src/main/java/org/archive/io/ArchiveReader.java b/src/main/java/org/archive/io/ArchiveReader.java index 66056d33..0038cccf 100644 --- a/src/main/java/org/archive/io/ArchiveReader.java +++ b/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; diff --git a/src/main/java/org/archive/io/GenericReplayCharSequence.java b/src/main/java/org/archive/io/GenericReplayCharSequence.java index 1af3922b..c427550b 100644 --- a/src/main/java/org/archive/io/GenericReplayCharSequence.java +++ b/src/main/java/org/archive/io/GenericReplayCharSequence.java @@ -45,13 +45,11 @@ /** * (Replay)CharSequence view on recorded streams. + ** + *

Call {@link #close()} on this class when done to clean up resources. * - * For small streams, use {@link InMemoryReplayCharSequence}. - * - *

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. * - *

See Encoding. + *

See Encoding. */ public static final Charset WRITE_ENCODING = Charsets.UTF_16BE; diff --git a/src/main/java/org/archive/io/MiserOutputStream.java b/src/main/java/org/archive/io/MiserOutputStream.java index f10ac9ca..f29256fd 100644 --- a/src/main/java/org/archive/io/MiserOutputStream.java +++ b/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; diff --git a/src/main/java/org/archive/io/Preformatter.java b/src/main/java/org/archive/io/Preformatter.java index dcd31bb6..c7099c51 100644 --- a/src/main/java/org/archive/io/Preformatter.java +++ b/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); diff --git a/src/main/java/org/archive/io/RecordingInputStream.java b/src/main/java/org/archive/io/RecordingInputStream.java index 36f539a9..95419280 100644 --- a/src/main/java/org/archive/io/RecordingInputStream.java +++ b/src/main/java/org/archive/io/RecordingInputStream.java @@ -225,7 +225,7 @@ public void readToEndOfContent(long contentLength) /** * Read all of a stream (Or read until we timeout or have read to the max). - * @param softMaxLength Maximum length to read; if zero or < 0, then no + * @param softMaxLength Maximum length to read; if zero or < 0, then no * limit. If met, return normally. * @throws IOException failed read. * @throws RecorderLengthExceededException diff --git a/src/main/java/org/archive/io/ReplayInputStream.java b/src/main/java/org/archive/io/ReplayInputStream.java index 35ea8175..60b0dc85 100644 --- a/src/main/java/org/archive/io/ReplayInputStream.java +++ b/src/main/java/org/archive/io/ReplayInputStream.java @@ -64,7 +64,7 @@ public class ReplayInputStream extends SeekInputStream * @param size Size of data to replay. * @param responseBodyStart Start of the response body. * @param backingFilename Backing file that sits behind the buffer. If - * size > than buffer then we go to backing file to read + * size > than buffer then we go to backing file to read * data that is beyond buffer.length. * * @throws IOException If we fail to open an input stream on @@ -84,7 +84,7 @@ public ReplayInputStream(byte[] buffer, long size, long responseBodyStart, * @param buffer Buffer to read from. * @param size Size of data to replay. * @param backingFilename Backing file that sits behind the buffer. If - * size > than buffer then we go to backing file to read + * size > than buffer then we go to backing file to read * data that is beyond buffer.length. * @throws IOException If we fail to open an input stream on * backing file. @@ -130,7 +130,7 @@ public ReplayInputStream(InputStream fillStream) throws IOException { } /** - * Close & destroy any internally-generated temporary files. + * Close & destroy any internally-generated temporary files. */ public void destroy() { IOUtils.closeQuietly(this); diff --git a/src/main/java/org/archive/io/RepositionableInputStream.java b/src/main/java/org/archive/io/RepositionableInputStream.java index 6f885130..838b5952 100644 --- a/src/main/java/org/archive/io/RepositionableInputStream.java +++ b/src/main/java/org/archive/io/RepositionableInputStream.java @@ -29,7 +29,7 @@ * stream. Uses a {@link BufferedInputStream}. Calls mark on every read so * we'll remember at least the last thing read (You can only backup on the * last thing read -- not last 2 or 3 things read). Used by - * {@link GzippedInputStream} when reading streams over a network. Wraps a + * GzippedInputStream when reading streams over a network. Wraps a * HTTP, etc., stream so we can back it up if needs be after the * GZIP inflater has done a fill of its full buffer though it only needed * the first few bytes to finish decompressing the current GZIP member. diff --git a/src/main/java/org/archive/io/WriterPool.java b/src/main/java/org/archive/io/WriterPool.java index 2dc385a1..db184c5f 100644 --- a/src/main/java/org/archive/io/WriterPool.java +++ b/src/main/java/org/archive/io/WriterPool.java @@ -88,10 +88,7 @@ public abstract class WriterPool { /** * Constructor * @param serial Used to generate unique filename sequences - * @param factory Factory that knows how to make a {@link WriterPoolMember}. * @param settings Settings for this pool. - * @param poolMaximumActive - * @param poolMaximumWait */ public WriterPool(final AtomicInteger serial, final WriterPoolSettings settings, diff --git a/src/main/java/org/archive/io/WriterPoolMember.java b/src/main/java/org/archive/io/WriterPoolMember.java index 85d44e5d..893007ec 100644 --- a/src/main/java/org/archive/io/WriterPoolMember.java +++ b/src/main/java/org/archive/io/WriterPoolMember.java @@ -125,9 +125,6 @@ public abstract class WriterPoolMember implements ArchiveFileConstants { * @param serialNo used to create unique filename sequences * @param out Where to write. * @param file File the out is connected to. - * @param cmprs Compress the content written. - * @param a14DigitDate If null, we'll write current time. - * @throws IOException */ protected WriterPoolMember(AtomicInteger serialNo, final OutputStream out, final File file, @@ -145,11 +142,6 @@ protected WriterPoolMember(AtomicInteger serialNo, * Constructor. * * @param serialNo used to create unique filename sequences - * @param dirs Where to drop files. - * @param prefix File prefix to use. - * @param cmprs Compress the records written. - * @param maxSize Maximum size for ARC files written. - * @param template filenaming template to use * @param extension Extension to give file. */ public WriterPoolMember(AtomicInteger serialNo, @@ -361,7 +353,6 @@ protected void postWriteRecordTasks() * Position in raw output (typically, physical file). * Used making accounting of bytes written. * @return Position in final media (assuming all flushing completes) - * @throws IOException */ public long getPosition() { return (countOut==null)? 0L : this.countOut.getCount(); diff --git a/src/main/java/org/archive/io/arc/ARCRecord.java b/src/main/java/org/archive/io/arc/ARCRecord.java index 2d9c9bf4..bacaca38 100644 --- a/src/main/java/org/archive/io/arc/ARCRecord.java +++ b/src/main/java/org/archive/io/arc/ARCRecord.java @@ -190,12 +190,10 @@ public ARCRecord(InputStream in, ArchiveRecordHeader metaData, * formatted). * @param parseHttpHeaders True if we are to parse HTTP headers. Costs * about ~20% of CPU during an ARC parse. - * @param isAllignedOnFirstRecord True if this is the first record to be + * @param isAlignedOnFirstRecord True if this is the first record to be * read from an archive - * @param String version Version information to be returned to the + * @param version Version information to be returned to the * ARCReader constructing this record - * - * @throws IOException */ public ARCRecord(InputStream in, final String identifier, final long offset, boolean digest, boolean strict, diff --git a/src/main/java/org/archive/io/arc/ARCWriter.java b/src/main/java/org/archive/io/arc/ARCWriter.java index b5825d50..0bd0ef9b 100644 --- a/src/main/java/org/archive/io/arc/ARCWriter.java +++ b/src/main/java/org/archive/io/arc/ARCWriter.java @@ -129,12 +129,7 @@ public class ARCWriter extends WriterPoolMember implements ARCConstants, Closeab * @param serialNo used to generate unique file name sequences * @param out Where to write. * @param arc File the out is connected to. - * @param cmprs Compress the content written. - * @param metadata File meta data. Can be null. Is list of File and/or - * String objects. - * @param a14DigitDate If null, we'll write current time. - * @throws IOException - */ +2 */ public ARCWriter(final AtomicInteger serialNo, final PrintStream out, final File arc, final WriterPoolSettings settings) throws IOException { diff --git a/src/main/java/org/archive/io/warc/WARCWriter.java b/src/main/java/org/archive/io/warc/WARCWriter.java index 7e22e08b..982b8bc4 100644 --- a/src/main/java/org/archive/io/warc/WARCWriter.java +++ b/src/main/java/org/archive/io/warc/WARCWriter.java @@ -53,7 +53,7 @@ * *

While being written, WARCs have a '.open' suffix appended. * - * @contributor stack + * @author stack * @version $Revision: 4604 $ $Date: 2006-09-05 22:38:18 -0700 (Tue, 05 Sep 2006) $ */ public class WARCWriter extends WriterPoolMember @@ -81,7 +81,7 @@ public class WARCWriter extends WriterPoolMember /** * Temporarily accumulates stats managed externally by - * {@link WARCWriterProcessor}. WARCWriterProcessor will call + * WARCWriterProcessor. WARCWriterProcessor will call * {@link #resetTmpStats()}, write some records, then add * {@link #getTmpStats()} into its long-term running totals. */ @@ -97,9 +97,6 @@ public class WARCWriter extends WriterPoolMember * @param serialNo used to generate unique file name sequences * @param out Where to write. * @param f File the out is connected to. - * @param cmprs Compress the content written. - * @param a14DigitDate If null, we'll write current time. - * @throws IOException */ public WARCWriter(final AtomicInteger serialNo, final OutputStream out, final File f, @@ -110,13 +107,6 @@ public WARCWriter(final AtomicInteger serialNo, /** * Constructor. - * - * @param dirs Where to drop files. - * @param prefix File prefix to use. - * @param cmprs Compress the records written. - * @param maxSize Maximum size for ARC files written. - * @param suffix File tail to use. If null, unused. - * @param warcinfoData File metadata for warcinfo record. */ public WARCWriter(final AtomicInteger serialNo, final WARCWriterPoolSettings settings) { diff --git a/src/main/java/org/archive/io/warc/WARCWriterPool.java b/src/main/java/org/archive/io/warc/WARCWriterPool.java index fdc97162..b94025df 100644 --- a/src/main/java/org/archive/io/warc/WARCWriterPool.java +++ b/src/main/java/org/archive/io/warc/WARCWriterPool.java @@ -26,8 +26,8 @@ /** * A pool of WARCWriters. - * @contributor stack - * @contributor gojomo + * @author stack + * @author gojomo * @version $Revision: 4566 $ $Date: 2006-08-31 09:51:41 -0700 (Thu, 31 Aug 2006) $ */ public class WARCWriterPool extends WriterPool { diff --git a/src/main/java/org/archive/io/warc/package.html b/src/main/java/org/archive/io/warc/package.html index f52aa95b..d3631d54 100644 --- a/src/main/java/org/archive/io/warc/package.html +++ b/src/main/java/org/archive/io/warc/package.html @@ -16,8 +16,8 @@

Implementation Notes

Tools

Initial implementations of Arc2Warc and Warc2Arc -tools can be found in the package above this one, at -{@link org.archive.io.Arc2Warc} and {@link org.archive.io.Warc2Arc} +tools can be found in Heritrix, at +org.archive.io.Arc2Warc and org.archive.io.Warc2Arc respectively. Pass --help to learn how to use each tool.

diff --git a/src/main/java/org/archive/net/PublicSuffixes.java b/src/main/java/org/archive/net/PublicSuffixes.java index eab8081a..af024949 100644 --- a/src/main/java/org/archive/net/PublicSuffixes.java +++ b/src/main/java/org/archive/net/PublicSuffixes.java @@ -74,7 +74,7 @@ public class PublicSuffixes { * prefix tree node. each Node represents sequence of letters (prefix) * and alternative sequences following it (list of Node's). Nodes in * {@code branches} are sorted for skip list like lookup and for generating - * effective regular expression (see {@link #compareTo(Node)} and {@link #compareTo(char).) + * effective regular expression (see {@link #compareTo(Node)} and {@link #compareTo(char)}. * * as is intended for internal use only, there's no access methods. procedures for updating * prefix tree with new input are defined within this class ({@link #addBranch(CharSequence)}). diff --git a/src/main/java/org/archive/resource/ResourceFactory.java b/src/main/java/org/archive/resource/ResourceFactory.java index 64b4eb4e..cddc8934 100755 --- a/src/main/java/org/archive/resource/ResourceFactory.java +++ b/src/main/java/org/archive/resource/ResourceFactory.java @@ -12,12 +12,6 @@ public interface ResourceFactory { /** * Attempts to create a Resource from the InputStream - * @param is - * @param metaData - * @param container - * @return - * @throws ResourceParseException - * @throws IOException */ public Resource getResource(InputStream is, MetaData parentMetaData, ResourceContainer container) diff --git a/src/main/java/org/archive/uid/RecordIDGenerator.java b/src/main/java/org/archive/uid/RecordIDGenerator.java index 97f1a022..4f16c5ab 100644 --- a/src/main/java/org/archive/uid/RecordIDGenerator.java +++ b/src/main/java/org/archive/uid/RecordIDGenerator.java @@ -25,14 +25,13 @@ /** * A record-id generator. * - * @contributor stack - * @contributor gojomo + * @author stack + * @author gojomo * @version $Revision$ $Date$ */ public interface RecordIDGenerator { /** * @return A URI that can serve as a record-id. - * @throws URISyntaxException */ public URI getRecordID(); diff --git a/src/main/java/org/archive/uid/package.html b/src/main/java/org/archive/uid/package.html index dc49f07b..bc69c9e3 100644 --- a/src/main/java/org/archive/uid/package.html +++ b/src/main/java/org/archive/uid/package.html @@ -8,13 +8,13 @@ Default is {@link org.archive.uid.UUIDGenerator}. To use another ID Generator, set the System Property org.archive.uid.GeneratorFactory.generator to point -at an alternate implementation of {@link org.archive.uid.Generator}. +at an alternate implementation of {@link org.archive.uid.RecordIDGenerator}.

TODO

  • MIME boundaries have upper-bound of 70 characters total including 'blank line' (CRLFCRLF) and two leading hyphens. Add to - {@link org.archive.uid.Generator} + {@link org.archive.uid.RecordIDGenerator} interface an upper-bound on generated ID length.
  • Add example of an actionable uid generator: e.g. http://archive.org/UID-SCHEME/ID diff --git a/src/main/java/org/archive/url/LaxURI.java b/src/main/java/org/archive/url/LaxURI.java index e1cea9b7..d7318dfd 100644 --- a/src/main/java/org/archive/url/LaxURI.java +++ b/src/main/java/org/archive/url/LaxURI.java @@ -243,8 +243,8 @@ protected void setURI() { * $3 = //jakarta.apache.org * authority = $4 = jakarta.apache.org * path = $5 = /ietf/uri/ - * $6 = - * query = $7 = + * $6 = <undefined> + * query = $7 = <undefined> * $8 = #Related * fragment = $9 = Related *

    diff --git a/src/main/java/org/archive/url/URLParser.java b/src/main/java/org/archive/url/URLParser.java index 83d3c386..a7860b02 100644 --- a/src/main/java/org/archive/url/URLParser.java +++ b/src/main/java/org/archive/url/URLParser.java @@ -30,7 +30,7 @@ public class URLParser { * The numbers in the second line above are only to assist readability; * they indicate the reference points for each subexpression (i.e., each * paired parenthesis). We refer to the value matched for subexpression - * as $. For example, matching the above expression to + * <n> as $<n>. For example, matching the above expression to * * http://www.ics.uci.edu/pub/ietf/uri/#Related * @@ -41,12 +41,12 @@ public class URLParser { * $3 = //www.ics.uci.edu * $4 = www.ics.uci.edu * $5 = /pub/ietf/uri/ - * $6 = - * $7 = + * $6 = <undefined> + * $7 = <undefined> * $8 = #Related * $9 = Related * - * where indicates that the component is not present, as is + * where <undefined> indicates that the component is not present, as is * the case for the query component in the above example. Therefore, we * can determine the value of the four components and fragment as * diff --git a/src/main/java/org/archive/url/UsableURIFactory.java b/src/main/java/org/archive/url/UsableURIFactory.java index 1059bfbd..d44b5c84 100644 --- a/src/main/java/org/archive/url/UsableURIFactory.java +++ b/src/main/java/org/archive/url/UsableURIFactory.java @@ -88,7 +88,7 @@ public class UsableURIFactory extends URI { * The numbers in the second line above are only to assist readability; * they indicate the reference points for each subexpression (i.e., each * paired parenthesis). We refer to the value matched for subexpression - * as $. For example, matching the above expression to + * <n> as $<n>. For example, matching the above expression to * * http://www.ics.uci.edu/pub/ietf/uri/#Related * @@ -99,12 +99,12 @@ public class UsableURIFactory extends URI { * $3 = //www.ics.uci.edu * $4 = www.ics.uci.edu * $5 = /pub/ietf/uri/ - * $6 = - * $7 = + * $6 = <undefined> + * $7 = <undefined> * $8 = #Related * $9 = Related * - * where indicates that the component is not present, as is + * where <undefined> indicates that the component is not present, as is * the case for the query component in the above example. Therefore, we * can determine the value of the four components and fragment as * @@ -340,9 +340,7 @@ protected UsableURI validityCheck(UsableURI uuri) throws URIException { * * @param uri URI as string. * @param base May be null. - * @param e True if the uri is already escaped. * @return A fixed up URI string. - * @throws URIException */ private String fixup(String uri, final URI base, final String charset) throws URIException { @@ -504,8 +502,8 @@ private String fixup(String uri, final URI base, final String charset) /** * If http(s) scheme, check scheme specific part begins '//'. - * @throws URIException - * @see http://www.faqs.org/rfcs/rfc1738.html Section 3.1. Common Internet + * @throws URIException + * @see Section 3.1. Common Internet * Scheme Syntax */ protected void checkHttpSchemeSpecificPartSlashPrefix(final URI base, diff --git a/src/main/java/org/archive/util/ArchiveUtils.java b/src/main/java/org/archive/util/ArchiveUtils.java index e4224384..22ba2787 100644 --- a/src/main/java/org/archive/util/ArchiveUtils.java +++ b/src/main/java/org/archive/util/ArchiveUtils.java @@ -52,7 +52,7 @@ /** * Miscellaneous useful methods. * - * @author gojomo & others + * @author gojomo & others */ public class ArchiveUtils { private static final Logger LOGGER = Logger.getLogger(ArchiveUtils.class.getName()); @@ -317,11 +317,6 @@ public static String get12DigitDate(Date d) { /** * A version of getDate which returns the default instead of throwing an exception if parsing fails - * - * @param d - * @param defaultDate - * @return - * @throws ParseException */ public static Date getDate(String d, Date defaultDate) { @@ -337,14 +332,13 @@ public static Date getDate(String d, Date defaultDate) } /** - * Parses an ARC-style date. If passed String is < 12 characters in length, - * we pad. At a minimum, String should contain a year (>=4 characters). + * Parses an ARC-style date. If passed String is < 12 characters in length, + * we pad. At a minimum, String should contain a year (>=4 characters). * Parse will also fail if day or month are incompletely specified. Depends * on the above getXXDigitDate methods. - * @param A 4-17 digit date in ARC style (yyyy to + * @param d A 4-17 digit date in ARC style (yyyy to * yyyyMMddHHmmssSSS) formatting. * @return A Date object representing the passed String. - * @throws ParseException */ public static Date getDate(String d) throws ParseException { Date date = null; @@ -605,7 +599,7 @@ public static boolean byteArrayEquals(final byte[] lhs, final byte[] rhs) { /** * Converts a double to a string. * @param val The double to convert - * @param precision How many characters to include after '.' + * @param maxFractionDigits How many characters to include after '.' * @return the double as a string. */ public static String doubleToString(double val, int maxFractionDigits){ @@ -628,7 +622,7 @@ public static String doubleToString(double val, int maxFractionDigits, int minFr * Takes a byte size and formats it for display with 'friendly' units. *

    * This involves converting it to the largest unit - * (of B, KiB, MiB, GiB, TiB) for which the amount will be > 1. + * (of B, KiB, MiB, GiB, TiB) for which the amount will be > 1. *

    * Additionally, at least 2 significant digits are always displayed. *

    @@ -807,7 +801,6 @@ public static String prettyString(Object obj) { /** * Provide a improved String of a Map's entries * - * @param Map * @return prettified (in curly brackets) string of Map contents */ public static String prettyString(Map map) { @@ -830,7 +823,6 @@ public static String prettyString(Map map) { /** * Provide a slightly-improved String of Object[] * - * @param Object[] * @return prettified (in square brackets) of Object[] */ public static String prettyString(Object[] array) { diff --git a/src/main/java/org/archive/util/ByteOp.java b/src/main/java/org/archive/util/ByteOp.java index c5a245c9..fc27d04a 100755 --- a/src/main/java/org/archive/util/ByteOp.java +++ b/src/main/java/org/archive/util/ByteOp.java @@ -178,7 +178,7 @@ public static byte[] readNBytes(InputStream is, int n) * @return array of bytes read, INCLUDING TRAILING NULL * @throws IOException if the underlying stream throws on, OR if the default * maximum buffer size is reached before a null byte is found - * @throws ShortByteReadException if EOF is encountered before a null byte + * @throws EOFException if EOF is encountered before a null byte */ public static byte[] readToNull(InputStream is) throws IOException { return readToNull(is,MAX_READ_SIZE); @@ -191,7 +191,7 @@ public static byte[] readToNull(InputStream is) throws IOException { * @return array of bytes read, INCLUDING TRAILING NULL * @throws IOException if the underlying stream throws on, OR if the * specified maximum buffer size is reached before a null byte is found - * @throws ShortByteReadException if EOF is encountered before a null byte + * @throws EOFException if EOF is encountered before a null byte */ public static byte[] readToNull(InputStream is, int maxSize) throws IOException { diff --git a/src/main/java/org/archive/util/DateUtils.java b/src/main/java/org/archive/util/DateUtils.java index d01b63ce..0be20e63 100755 --- a/src/main/java/org/archive/util/DateUtils.java +++ b/src/main/java/org/archive/util/DateUtils.java @@ -165,7 +165,7 @@ public static String get14DigitDate(long date){ * in the format yyyyMMddHHmmss. * Date stamps are in the UTC time zone * - * @param date Date for timestamp + * @param d Date for timestamp * @return the date stamp */ public static String get14DigitDate(Date d) { @@ -203,7 +203,7 @@ public static String get12DigitDate(long date){ * in the format yyyyMMddHHmm. * Date stamps are in the UTC time zone * - * @param date Date object to format + * @param d Date object to format * @return the date stamp */ public static String get12DigitDate(Date d) { @@ -301,11 +301,11 @@ public static String getLog14Date(Date date){ */ /** - * Parses an ARC-style date. If passed String is < 12 characters in length, - * we pad. At a minimum, String should contain a year (>=4 characters). + * Parses an ARC-style date. If passed String is < 12 characters in length, + * we pad. At a minimum, String should contain a year (>=4 characters). * Parse will also fail if day or month are incompletely specified. Depends * on the above getXXDigitDate methods. - * @param A 4-17 digit date in ARC style (yyyy to + * @param d A 4-17 digit date in ARC style (yyyy to * yyyyMMddHHmmssSSS) formatting. * @return A Date object representing the passed String. * @throws ParseException @@ -539,7 +539,7 @@ public static boolean byteArrayEquals(final byte[] lhs, final byte[] rhs) { /** * Converts a double to a string. * @param val The double to convert - * @param precision How many characters to include after '.' + * @param maxFractionDigits How many characters to include after '.' * @return the double as a string. */ public static String doubleToString(double val, int maxFractionDigits){ diff --git a/src/main/java/org/archive/util/FileUtils.java b/src/main/java/org/archive/util/FileUtils.java index 3de276a9..55255e2e 100644 --- a/src/main/java/org/archive/util/FileUtils.java +++ b/src/main/java/org/archive/util/FileUtils.java @@ -44,8 +44,8 @@ /** Utility methods for manipulating files and directories. * - * @contributor John Erik Halse - * @contributor gojomo + * @author John Erik Halse + * @author gojomo */ public class FileUtils { private static final Logger LOGGER = @@ -384,7 +384,7 @@ public static boolean moveAsideIfExists(File file) throws IOException { * want this number of lines ending with a line containing * the position; if positive, want this number of lines, * all starting at or after position. - * @param lines List to insert found lines + * @param lines list to insert found lines * @param lineEstimate int estimate of line size, 0 means use default * of 128 * @return LongRange indicating the file offsets corresponding to diff --git a/src/main/java/org/archive/util/IAUtils.java b/src/main/java/org/archive/util/IAUtils.java index d3cf5cf9..4597d723 100644 --- a/src/main/java/org/archive/util/IAUtils.java +++ b/src/main/java/org/archive/util/IAUtils.java @@ -32,7 +32,7 @@ /** * Miscellaneous useful methods. * - * @author gojomo & others + * @author gojomo & others */ public class IAUtils { public final static Charset UTF8 = Charset.forName("utf-8"); diff --git a/src/main/java/org/archive/util/IterableLineIterator.java b/src/main/java/org/archive/util/IterableLineIterator.java index 6e0d9dc8..33efa1fd 100644 --- a/src/main/java/org/archive/util/IterableLineIterator.java +++ b/src/main/java/org/archive/util/IterableLineIterator.java @@ -9,7 +9,7 @@ * A LineIterator that also implements Iterable, so that it can be used with * the java enhanced for-each loop syntax. * - * @contributor nlevitt + * @author nlevitt */ public class IterableLineIterator extends LineIterator implements Iterable { diff --git a/src/main/java/org/archive/util/LaxHttpParser.java b/src/main/java/org/archive/util/LaxHttpParser.java index c1f768f0..9e38669b 100644 --- a/src/main/java/org/archive/util/LaxHttpParser.java +++ b/src/main/java/org/archive/util/LaxHttpParser.java @@ -66,7 +66,7 @@ protected LaxHttpParser() { } /** * Return byte array from an (unchunked) input stream. - * Stop reading when "\n" terminator encountered + * Stop reading when "\n" terminator encountered * If the stream ends before the line terminator is found, * the last part of the string will still be returned. * If no input data available, null is returned. @@ -94,7 +94,7 @@ public static byte[] readRawLine(InputStream inputStream) throws IOException { } /** - * Read up to "\n" from an (unchunked) input stream. + * Read up to "\n" from an (unchunked) input stream. * If the stream ends before the line terminator is found, * the last part of the string will still be returned. * If no input data available, null is returned. @@ -130,7 +130,7 @@ public static String readLine(InputStream inputStream, String charset) throws IO } /** - * Read up to "\n" from an (unchunked) input stream. + * Read up to "\n" from an (unchunked) input stream. * If the stream ends before the line terminator is found, * the last part of the string will still be returned. * If no input data available, null is returned diff --git a/src/main/java/org/archive/util/PropertyUtils.java b/src/main/java/org/archive/util/PropertyUtils.java index 083615f6..e29862bf 100644 --- a/src/main/java/org/archive/util/PropertyUtils.java +++ b/src/main/java/org/archive/util/PropertyUtils.java @@ -26,8 +26,8 @@ /** * Utilities for dealing with Java Properties (incl. System Properties) * - * @contributor stack - * @contributor gojomo + * @author stack + * @author gojomo * @version $Date$ $Revision$ */ public class PropertyUtils { @@ -67,7 +67,6 @@ public static int getIntProperty(final String key, final int fallback) { * the expression is replaced with the empty-string. * * @param original String - * @param properties Properties to try in order; first value found (if any) is used * @return modified String */ public static String interpolateWithProperties(String original) { diff --git a/src/main/java/org/archive/util/Recorder.java b/src/main/java/org/archive/util/Recorder.java index 425344bb..dff02bff 100644 --- a/src/main/java/org/archive/util/Recorder.java +++ b/src/main/java/org/archive/util/Recorder.java @@ -310,8 +310,7 @@ public static Recorder getHttpRecorder() { } /** - * @param characterEncoding Character encoding of input recording. - * @return actual charset in use after attempt to set + * @param cs Character encoding of input recording. */ public void setCharset(Charset cs) { this.charset = cs; @@ -324,9 +323,6 @@ public Charset getCharset() { return this.charset; } - /** - * @param characterEncoding Character encoding of input recording. - */ public void setInputIsChunked(boolean chunked) { this.inputIsChunked = chunked; } @@ -374,7 +370,7 @@ public ReplayCharSequence getReplayCharSequence() throws IOException { * processing has finished; in that context it's preferable not * to close, so that processors can reuse the same instance. * @throws IOException - * @see {@link #endReplays()} + * @see #endReplays() */ public ReplayCharSequence getContentReplayCharSequence() throws IOException { if (replayCharSequence == null || !replayCharSequence.isOpen() @@ -390,7 +386,7 @@ public ReplayCharSequence getContentReplayCharSequence() throws IOException { /** - * @param characterEncoding Encoding of recorded stream. + * @param requestedCharset Encoding of recorded stream. * @return A ReplayCharSequence Will return null if an IOException. Call * close on returned RCS when done. * @throws IOException diff --git a/src/main/java/org/archive/util/Reporter.java b/src/main/java/org/archive/util/Reporter.java index 2fcb8cd8..3f4ea5e5 100644 --- a/src/main/java/org/archive/util/Reporter.java +++ b/src/main/java/org/archive/util/Reporter.java @@ -35,7 +35,7 @@ public interface Reporter { /** * Write a short single-line summary report * - * @param writer to receive report + * @param pw writer to receive report */ @Deprecated public void shortReportLineTo(PrintWriter pw) throws IOException; diff --git a/src/main/java/org/archive/util/SurtPrefixSet.java b/src/main/java/org/archive/util/SurtPrefixSet.java index b0da4321..6925cc83 100644 --- a/src/main/java/org/archive/util/SurtPrefixSet.java +++ b/src/main/java/org/archive/util/SurtPrefixSet.java @@ -56,7 +56,6 @@ public class SurtPrefixSet extends PrefixSet { * with redundant entries removed. * * @param r reader over file of SURT_format strings - * @throws IOException */ public void importFrom(Reader r) { BufferedReader reader = new BufferedReader(r); @@ -236,7 +235,7 @@ public static String asPrefix(String s) { * Calculate the SURT form URI to use as a candidate against prefixes * from the given Object (CandidateURI or UURI) * - * @param object CandidateURI or UURI + * @param u CandidateURI or UURI * @return SURT form of URI for evaluation, or null if unavailable */ public static String getCandidateSurt(UsableURI u) { diff --git a/src/main/java/org/archive/util/TextUtils.java b/src/main/java/org/archive/util/TextUtils.java index 9061a161..42e5f31f 100644 --- a/src/main/java/org/archive/util/TextUtils.java +++ b/src/main/java/org/archive/util/TextUtils.java @@ -230,7 +230,7 @@ public static String escapeForHTML(String s) { * escaping it for HTML display, without constructing another large String * of the whole content. * @param s String to write - * @param out destination JspWriter + * @param w destination Writer * @throws IOException */ public static void writeEscapedForHTML(String s, Writer w) diff --git a/src/main/java/org/archive/util/anvl/ANVLRecord.java b/src/main/java/org/archive/util/anvl/ANVLRecord.java index de2d3101..06603914 100644 --- a/src/main/java/org/archive/util/anvl/ANVLRecord.java +++ b/src/main/java/org/archive/util/anvl/ANVLRecord.java @@ -190,11 +190,11 @@ public static ANVLRecord load(final InputStream is) return load(new String(baos.toByteArray(), UTF8)); } - /** + /** * Parse passed String for an ANVL Record. * Looked at writing javacc grammer but preprocessing is required to * handle folding: See - * https://javacc.dev.java.net/servlets/BrowseList?list=users&by=thread&from=56173. + * here. * Looked at Terence Parr's ANTLR. More capable. Can set lookahead count. * A value of 3 would help with folding. But its a pain defining UNICODE * grammers -- needed by ANVL -- and support seems incomplete @@ -202,7 +202,7 @@ public static ANVLRecord load(final InputStream is) * For now, go with the below hand-rolled parser. * @param s String with an ANVLRecord. * @return ANVLRecord parsed from passed String. - * @throws IOException + * @throws IOException */ public static ANVLRecord load(final String s) throws IOException { diff --git a/src/main/java/org/archive/util/anvl/package.html b/src/main/java/org/archive/util/anvl/package.html index 4a2a8963..f5164631 100644 --- a/src/main/java/org/archive/util/anvl/package.html +++ b/src/main/java/org/archive/util/anvl/package.html @@ -37,6 +37,5 @@

    Implementation Details

    of combinations of atom, quoted-string, and specials tokens, or else consisting of texts> -

    diff --git a/src/main/java/org/archive/util/binsearch/ByteBufferInputStream.java b/src/main/java/org/archive/util/binsearch/ByteBufferInputStream.java index f5f75fa4..35cb0ee8 100644 --- a/src/main/java/org/archive/util/binsearch/ByteBufferInputStream.java +++ b/src/main/java/org/archive/util/binsearch/ByteBufferInputStream.java @@ -37,7 +37,7 @@ *

    Java's {@linkplain FileChannel#map(MapMode, long, long) memory-mapping facilities} have * the severe limitation of mapping at most {@link Integer#MAX_VALUE} bytes, as they * expose the content of a file using a {@link MappedByteBuffer}. This class can {@linkplain #map(FileChannel, FileChannel.MapMode) expose - * a file of arbitrary length} as a {@linkplain RepositionableStream repositionable} {@link MeasurableInputStream} + * a file of arbitrary length} as a repositionable input stream * that is actually based on an array of {@link MappedByteBuffer}s, each mapping * a chunk of {@link #CHUNK_SIZE} bytes. * diff --git a/src/main/java/org/archive/util/iterator/CloseableIteratorWrapper.java b/src/main/java/org/archive/util/iterator/CloseableIteratorWrapper.java index f35c85e5..d29d2ce2 100644 --- a/src/main/java/org/archive/util/iterator/CloseableIteratorWrapper.java +++ b/src/main/java/org/archive/util/iterator/CloseableIteratorWrapper.java @@ -4,7 +4,7 @@ import java.util.Iterator; /** - * Wrap a regular Iterator to create a CloseableIterator where the close() is a no-op + * Wrap a regular Iterator<S> to create a CloseableIterator<S> where the close() is a no-op * @author ilya * * @param diff --git a/src/main/java/org/archive/util/zip/GZIPMembersInputStream.java b/src/main/java/org/archive/util/zip/GZIPMembersInputStream.java index 1838f4b9..82476b6a 100644 --- a/src/main/java/org/archive/util/zip/GZIPMembersInputStream.java +++ b/src/main/java/org/archive/util/zip/GZIPMembersInputStream.java @@ -61,7 +61,7 @@ * position. Calling nextMember() after receiving an EOF will allow reading * to proceed into the next member (if any). * - * @contributor gojomo + * @author gojomo */ public class GZIPMembersInputStream extends OpenJDK7GZIPInputStream { protected long memberNumber = 0; @@ -273,7 +273,6 @@ public Inflater getInflater() { * stream from next() should finish (reaching EOF) before the iterator's * hasNext() or next() is called. * - * @return Iterator of * @deprecated for backward compatibility; better to use direct facilities in future */ public Iterator memberIterator() { diff --git a/src/main/java/org/archive/util/zip/OpenJDK7GZIPInputStream.java b/src/main/java/org/archive/util/zip/OpenJDK7GZIPInputStream.java index 044597f0..3c010c39 100644 --- a/src/main/java/org/archive/util/zip/OpenJDK7GZIPInputStream.java +++ b/src/main/java/org/archive/util/zip/OpenJDK7GZIPInputStream.java @@ -41,7 +41,7 @@ * This class implements a stream filter for reading compressed data in * the GZIP file format. * - * @see InflaterInputStream + * @see OpenJDK7InflaterInputStream * @author David Connelly * */ @@ -76,7 +76,7 @@ private void ensureOpen() throws IOException { * @exception ZipException if a GZIP format error has occurred or the * compression method used is unsupported * @exception IOException if an I/O error has occurred - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if size is <= 0 */ public OpenJDK7GZIPInputStream(InputStream in, int size) throws IOException { super(in, new Inflater(true), size); diff --git a/src/main/java/org/archive/util/zip/OpenJDK7InflaterInputStream.java b/src/main/java/org/archive/util/zip/OpenJDK7InflaterInputStream.java index 5f4c5122..11d458e1 100644 --- a/src/main/java/org/archive/util/zip/OpenJDK7InflaterInputStream.java +++ b/src/main/java/org/archive/util/zip/OpenJDK7InflaterInputStream.java @@ -79,7 +79,7 @@ private void ensureOpen() throws IOException { * @param in the input stream * @param inf the decompressor ("inflater") * @param size the input buffer size - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if size is <= 0 */ public OpenJDK7InflaterInputStream(InputStream in, Inflater inf, int size) { super(in); @@ -195,7 +195,7 @@ public int available() throws IOException { * @param n the number of bytes to skip * @return the actual number of bytes skipped. * @exception IOException if an I/O error has occurred - * @exception IllegalArgumentException if n < 0 + * @exception IllegalArgumentException if n < 0 */ public long skip(long n) throws IOException { if (n < 0) { diff --git a/src/test/java/org/archive/util/FileUtilsTest.java b/src/test/java/org/archive/util/FileUtilsTest.java index 19271435..01625627 100644 --- a/src/test/java/org/archive/util/FileUtilsTest.java +++ b/src/test/java/org/archive/util/FileUtilsTest.java @@ -32,8 +32,8 @@ /** * FileUtils tests. * - * @contributor stack - * @contributor gojomo + * @author stack + * @author gojomo * @version $Date$, $Revision$ */ public class FileUtilsTest extends TmpDirTestCase { diff --git a/src/test/java/org/archive/util/PropertyUtilsTest.java b/src/test/java/org/archive/util/PropertyUtilsTest.java index 0666efb7..fb73656b 100644 --- a/src/test/java/org/archive/util/PropertyUtilsTest.java +++ b/src/test/java/org/archive/util/PropertyUtilsTest.java @@ -29,7 +29,7 @@ /** * PropertyUtils tests. * - * @contributor gojomo + * @author gojomo * @version $Date: 2009-11-19 14:39:53 -0800 (Thu, 19 Nov 2009) $, $Revision: 6674 $ */ public class PropertyUtilsTest extends TestCase { diff --git a/src/test/java/org/archive/util/zip/GZIPMembersInputStreamTest.java b/src/test/java/org/archive/util/zip/GZIPMembersInputStreamTest.java index 710ff069..0c70263e 100644 --- a/src/test/java/org/archive/util/zip/GZIPMembersInputStreamTest.java +++ b/src/test/java/org/archive/util/zip/GZIPMembersInputStreamTest.java @@ -35,7 +35,7 @@ /** * Tests for GZIPMembersInputStream - * @contributor gojomo + * @author gojomo * @version $ $ */ public class GZIPMembersInputStreamTest extends TestCase { From ce4b7b8ed23a5e7fbf34efc4e234e4e9a8c413c0 Mon Sep 17 00:00:00 2001 From: Alex Osborne Date: Tue, 15 Oct 2024 17:30:16 +0900 Subject: [PATCH 3/5] Fix javadoc build errors affecting JDK 8 --- src/main/java/org/archive/format/gzip/GZIPStaticHeader.java | 2 +- src/main/java/org/archive/io/ReplayCharSequence.java | 2 +- src/main/java/org/archive/io/arc/ARCWriter.java | 6 +++--- src/main/java/org/archive/util/DateUtils.java | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/archive/format/gzip/GZIPStaticHeader.java b/src/main/java/org/archive/format/gzip/GZIPStaticHeader.java index ca0e8990..21406657 100755 --- a/src/main/java/org/archive/format/gzip/GZIPStaticHeader.java +++ b/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 { diff --git a/src/main/java/org/archive/io/ReplayCharSequence.java b/src/main/java/org/archive/io/ReplayCharSequence.java index aa9b9587..e456e293 100644 --- a/src/main/java/org/archive/io/ReplayCharSequence.java +++ b/src/main/java/org/archive/io/ReplayCharSequence.java @@ -59,7 +59,7 @@ public interface ReplayCharSequence extends CharSequence, Closeable { public long getDecodeExceptionCount(); /** - * Return the first coding-exception encountered, if the count > 0. + * Return the first coding-exception encountered, if the count > 0. * @return CharacterCodingException */ public CharacterCodingException getCodingException(); diff --git a/src/main/java/org/archive/io/arc/ARCWriter.java b/src/main/java/org/archive/io/arc/ARCWriter.java index 0bd0ef9b..c7042943 100644 --- a/src/main/java/org/archive/io/arc/ARCWriter.java +++ b/src/main/java/org/archive/io/arc/ARCWriter.java @@ -86,7 +86,7 @@ * write our own GZIP*Streams, ones that resettable and consious of gzip * members. * - *

    This class will write until we hit >= maxSize. The check is done at + *

    This class will write until we hit >= maxSize. The check is done at * record boundary. Records do not span ARC files. We will then close current * file and open another and then continue writing. * @@ -95,9 +95,9 @@ * alexa * ARC c-tools: * 

    - * % av_procarc hx20040109230030-0.arc.gz | av_ziparc > \
+ * % av_procarc hx20040109230030-0.arc.gz | av_ziparc > \
  *     /tmp/hx20040109230030-0.dat.gz
- * % av_ripdat /tmp/hx20040109230030-0.dat.gz > /tmp/hx20040109230030-0.cdx
+ * % av_ripdat /tmp/hx20040109230030-0.dat.gz > /tmp/hx20040109230030-0.cdx
  *
    * Examine the produced cdx file to make sure it makes sense. Search * for 'no-type 0'. If found, then we're opening a gzip record w/o data to diff --git a/src/main/java/org/archive/util/DateUtils.java b/src/main/java/org/archive/util/DateUtils.java index 0be20e63..7d6a7c98 100755 --- a/src/main/java/org/archive/util/DateUtils.java +++ b/src/main/java/org/archive/util/DateUtils.java @@ -557,7 +557,7 @@ private static String doubleToString(double val, int maxFractionDigits, int minF * Takes a byte size and formats it for display with 'friendly' units. *

    * This involves converting it to the largest unit - * (of B, KiB, MiB, GiB, TiB) for which the amount will be > 1. + * (of B, KiB, MiB, GiB, TiB) for which the amount will be > 1. *

    * Additionally, at least 2 significant digits are always displayed. *

    From 0d881e967daf2a023006032dd0d015b714821b11 Mon Sep 17 00:00:00 2001 From: Alex Osborne Date: Tue, 15 Oct 2024 17:42:23 +0900 Subject: [PATCH 4/5] [maven-release-plugin] prepare release webarchive-commons-1.1.10 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index f0c6ac73..2dd9223b 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ org.netpreserve.commons webarchive-commons - 1.1.10-SNAPSHOT + 1.1.10 jar webarchive-commons From 76d95ccd75ddc31c5b8c3e9136f9e422ab528898 Mon Sep 17 00:00:00 2001 From: Alex Osborne Date: Tue, 15 Oct 2024 17:42:28 +0900 Subject: [PATCH 5/5] [maven-release-plugin] prepare for next development iteration --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 2dd9223b..dc3088f0 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ org.netpreserve.commons webarchive-commons - 1.1.10 + 1.1.11-SNAPSHOT jar webarchive-commons