This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
The following commit(s) were added to refs/heads/master by this push:
new c0134c8f7 Javadoc
c0134c8f7 is described below
commit c0134c8f70d18a8ca3800d53dc0e5ac43ea016d0
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Aug 20 06:53:15 2025 -0400
Javadoc
---
.../compress/compressors/gzip/ExtraField.java | 2 +-
.../gzip/GzipCompressorInputStream.java | 10 ++++----
.../lzma/LZMACompressorInputStream.java | 2 +-
.../lzma/LZMACompressorOutputStream.java | 2 +-
.../compressors/xz/XZCompressorInputStream.java | 4 ++--
.../compressors/xz/XZCompressorOutputStream.java | 2 +-
.../zstandard/ZstdCompressorOutputStream.java | 28 +++++++++++-----------
7 files changed, 25 insertions(+), 25 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
index 3b1df7fa6..8881a6397 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
@@ -222,7 +222,7 @@ public ExtraField() {
*
* @param id The subfield ID.
* @param payload The subfield payload.
- * @return this instance.
+ * @return {@code this} instance.
* @throws NullPointerException if {@code id} is {@code null}.
* @throws NullPointerException if {@code payload} is {@code null}.
* @throws IllegalArgumentException if the subfield is not 2 characters or
the payload is null
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
index e9243c5e0..a6664cc5a 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
@@ -131,7 +131,7 @@ public GzipCompressorInputStream get() throws IOException {
* Sets whether we should allow decompressing multiple members.
*
* @param decompressConcatenated whether we should allow decompressing
multiple members.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setDecompressConcatenated(final boolean
decompressConcatenated) {
this.decompressConcatenated = decompressConcatenated;
@@ -149,7 +149,7 @@ public Builder setDecompressConcatenated(final boolean
decompressConcatenated) {
* </p>
*
* @param fileNameCharset the Charset to use for writing file names
and comments, null maps to {@link GzipUtils#GZIP_ENCODING}.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setFileNameCharset(final Charset fileNameCharset) {
this.fileNameCharset = fileNameCharset;
@@ -160,7 +160,7 @@ public Builder setFileNameCharset(final Charset
fileNameCharset) {
* Sets whether to ignore extra fields. To best comply with gzip, this
defaults to true.
*
* @param ignoreExtraFields whether to ignore extra fields.
- * @return this instance.
+ * @return {@code this} instance.
* @since 1.29.0
*/
public Builder setIgnoreExtraField(final boolean ignoreExtraFields) {
@@ -178,7 +178,7 @@ public Builder setIgnoreExtraField(final boolean
ignoreExtraFields) {
* </p>
*
* @param onMemberEnd The consumer.
- * @return this instance.
+ * @return {@code this} instance.
* @see GzipCompressorInputStream#getMetaData()
*/
public Builder setOnMemberEnd(final
IOConsumer<GzipCompressorInputStream> onMemberEnd) {
@@ -196,7 +196,7 @@ public Builder setOnMemberEnd(final
IOConsumer<GzipCompressorInputStream> onMemb
* </p>
*
* @param onMemberStart The consumer.
- * @return this instance.
+ * @return {@code this} instance.
* @see GzipCompressorInputStream#getMetaData()
*/
public Builder setOnMemberStart(final
IOConsumer<GzipCompressorInputStream> onMemberStart) {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
index 679faa6f3..3743f4ecb 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
@@ -69,7 +69,7 @@ public LZMACompressorInputStream get() throws IOException {
*
* @param memoryLimitKiB Sets a working memory threshold in kibibytes
(KiB). Processing throws MemoryLimitException if memory use is above this
* threshold.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setMemoryLimitKiB(final int memoryLimitKiB) {
this.memoryLimitKiB = memoryLimitKiB;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
index 4aae9eb89..4aa1dd1d5 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
@@ -76,7 +76,7 @@ public LZMACompressorOutputStream get() throws IOException {
* </p>
*
* @param lzma2Options LZMA options.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setLzma2Options(final LZMA2Options lzma2Options) {
this.lzma2Options = lzma2Options != null ? lzma2Options : new
LZMA2Options();
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
index a036421f7..9f8e2356e 100644
---
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
@@ -88,7 +88,7 @@ public XZCompressorInputStream get() throws IOException {
*
* @param decompressConcatenated if true, decompress until the end of
the input; if false, stop after the first .xz stream and leave the input
position
* to point to the next byte after the
.xz stream
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setDecompressConcatenated(final boolean
decompressConcatenated) {
this.decompressConcatenated = decompressConcatenated;
@@ -101,7 +101,7 @@ public Builder setDecompressConcatenated(final boolean
decompressConcatenated) {
*
* @param memoryLimitKiB The memory limit used when reading blocks.
The memory usage limit is expressed in kibibytes (KiB) or {@code -1} to impose
no
* memory usage limit. If the estimated memory
limit is exceeded on {@link #read()}, a {@link MemoryLimitException} is thrown.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setMemoryLimitKiB(final int memoryLimitKiB) {
this.memoryLimitKiB = memoryLimitKiB;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
index 23a04d60f..eab481630 100644
---
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
@@ -93,7 +93,7 @@ public XZCompressorOutputStream get() throws IOException {
* </p>
*
* @param lzma2Options LZMA options.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setLzma2Options(final LZMA2Options lzma2Options) {
this.lzma2Options = lzma2Options != null ? lzma2Options : new
LZMA2Options();
diff --git
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
index 9b6880b51..e3bc7a7f2 100644
---
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
@@ -106,7 +106,7 @@ public ZstdCompressorOutputStream get() throws IOException {
* </p>
*
* @param chainLog the size of the multi-probe search table, as a
power of 2.
- * @return this instance.
+ * @return {@code this} instance.
* @see ZstdConstants#ZSTD_CHAINLOG_MIN
* @see ZstdConstants#ZSTD_CHAINLOG_MAX
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
@@ -124,7 +124,7 @@ public Builder setChainLog(final int chainLog) {
* </p>
*
* @param checksum Whether a 32-bits checksum of content is written at
end of frame.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -144,7 +144,7 @@ public Builder setChecksum(final boolean checksum) {
* </p>
*
* @param closeFrameOnFlush whether to close the frame on flush.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -168,7 +168,7 @@ public Builder setCloseFrameOnFlush(final boolean
closeFrameOnFlush) {
* </ul>
*
* @param dict The dictionary buffer.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter12";>Zstd manual
Chapter12</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -189,7 +189,7 @@ public Builder setDict(final byte[] dict) {
* </p>
*
* @param hashLog Size of the initial probe table, as a power of 2.
- * @return this instance.
+ * @return {@code this} instance.
* @see ZstdConstants#ZSTD_HASHLOG_MIN
* @see ZstdConstants#ZSTD_HASHLOG_MAX
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
@@ -214,7 +214,7 @@ public Builder setHashLog(final int hashLog) {
* </p>
*
* @param jobSize Size of a compression job.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/compress/zstdmt_compress.h";>zstdmt_compress.h</a>
*/
@@ -237,7 +237,7 @@ public Builder setJobSize(final int jobSize) {
* </ul>
*
* @param level The compression level, from 0 to 9, where the default
is {@link ZstdConstants#ZSTD_CLEVEL_DEFAULT}.
- * @return this instance
+ * @return {@code this} instance
* @see ZstdConstants#ZSTD_CLEVEL_DEFAULT
* @see ZstdConstants#ZSTD_CLEVEL_MIN
* @see ZstdConstants#ZSTD_CLEVEL_MAX
@@ -262,7 +262,7 @@ public Builder setLevel(final int level) {
* </p>
*
* @param minMatch minimum match size for long distance matcher.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -307,7 +307,7 @@ public Builder setMinMatch(final int minMatch) {
* </p>
*
* @param overlapLog the overlap size, as a fraction of window size.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -326,7 +326,7 @@ public Builder setOverlapLog(final int overlapLog) {
* </p>
*
* @param searchLog number of search attempts, as a power of 2.
- * @return this instance.
+ * @return {@code this} instance.
* @see ZstdConstants#ZSTD_SEARCHLOG_MIN
* @see ZstdConstants#ZSTD_SEARCHLOG_MAX
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
@@ -358,7 +358,7 @@ public Builder setSearchLog(final int searchLog) {
* </ul>
*
* @param strategy the {@code ZSTD_strategy} from the C enum
definition.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -388,7 +388,7 @@ public Builder setStrategy(final int strategy) {
* </p>
*
* @param targetLength a value that depends on the strategy, see
{@code ZSTD_c_targetLength}.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
@@ -412,7 +412,7 @@ public Builder setTargetLength(final int targetLength) {
* </p>
*
* @param windowLog maximum allowed back-reference distance, expressed
as power of 2.
- * @return this instance.
+ * @return {@code this} instance.
* @see ZstdConstants#ZSTD_WINDOWLOG_MIN
* @see ZstdConstants#ZSTD_WINDOWLOG_MAX
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
@@ -439,7 +439,7 @@ public Builder setWindowLog(final int windowLog) {
* </p>
*
* @param workers How many threads will be spawned to compress in
parallel.
- * @return this instance.
+ * @return {@code this} instance.
* @see <a
href="https://facebook.github.io/zstd/zstd_manual.html#Chapter5";>Zstd manual
Chapter5</a>
* @see <a
href="https://github.com/facebook/zstd/blob/dev/lib/zstd.h";>zstd.h</a>
*/
