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 646ee94da Javadoc 646ee94da is described below commit 646ee94da0943b4ab05d5ff5e730af7b456d539c Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu May 23 09:16:39 2024 -0400 Javadoc --- .../commons/compress/archivers/sevenz/SevenZFile.java | 16 ++++++++-------- .../apache/commons/compress/archivers/zip/ZipFile.java | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java index 9ccbe38e4..3611e3623 100644 --- a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java +++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java @@ -198,7 +198,7 @@ public class SevenZFile implements Closeable { * Sets the default name. * * @param defaultName the default name. - * @return this. + * @return {@code this} instance. */ public Builder setDefaultName(final String defaultName) { this.defaultName = defaultName; @@ -212,7 +212,7 @@ public class SevenZFile implements Closeable { * </p> * * @param maxMemoryLimitKb the max memory limit in kilobytes. - * @return this. + * @return {@code this} instance. */ public Builder setMaxMemoryLimitKb(final int maxMemoryLimitKb) { this.maxMemoryLimitKb = maxMemoryLimitKb; @@ -223,7 +223,7 @@ public class SevenZFile implements Closeable { * Sets the password. * * @param password the password. - * @return this. + * @return {@code this} instance. */ public Builder setPassword(final byte[] password) { this.password = password != null ? password.clone() : null; @@ -234,7 +234,7 @@ public class SevenZFile implements Closeable { * Sets the password. * * @param password the password. - * @return this. + * @return {@code this} instance. */ public Builder setPassword(final char[] password) { this.password = password != null ? AES256SHA256Decoder.utf16Decode(password.clone()) : null; @@ -245,7 +245,7 @@ public class SevenZFile implements Closeable { * Sets the password. * * @param password the password. - * @return this. + * @return {@code this} instance. */ public Builder setPassword(final String password) { this.password = password != null ? AES256SHA256Decoder.utf16Decode(password.toCharArray()) : null; @@ -256,7 +256,7 @@ public class SevenZFile implements Closeable { * Sets the input channel. * * @param seekableByteChannel the input channel. - * @return this. + * @return {@code this} instance. */ public Builder setSeekableByteChannel(final SeekableByteChannel seekableByteChannel) { this.seekableByteChannel = seekableByteChannel; @@ -272,7 +272,7 @@ public class SevenZFile implements Closeable { * </p> * * @param tryToRecoverBrokenArchives whether {@link SevenZFile} will try to recover broken archives where the CRC of the file's metadata is 0. - * @return this. + * @return {@code this} instance. */ public Builder setTryToRecoverBrokenArchives(final boolean tryToRecoverBrokenArchives) { this.tryToRecoverBrokenArchives = tryToRecoverBrokenArchives; @@ -283,7 +283,7 @@ public class SevenZFile implements Closeable { * Sets whether entries without a name should get their names set to the archive's default file name. * * @param useDefaultNameForUnnamedEntries whether entries without a name should get their names set to the archive's default file name. - * @return this. + * @return {@code this} instance. */ public Builder setUseDefaultNameForUnnamedEntries(final boolean useDefaultNameForUnnamedEntries) { this.useDefaultNameForUnnamedEntries = useDefaultNameForUnnamedEntries; diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java index 89cf5fcb8..8b48fe0f2 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java @@ -167,7 +167,7 @@ public class ZipFile implements Closeable { * Sets whether to ignore information stored inside the local file header. * * @param ignoreLocalFileHeader whether to ignore information stored inside. - * @return this. + * @return {@code this} instance. */ public Builder setIgnoreLocalFileHeader(final boolean ignoreLocalFileHeader) { this.ignoreLocalFileHeader = ignoreLocalFileHeader; @@ -179,7 +179,7 @@ public class ZipFile implements Closeable { * * @param maxNumberOfDisks max number of multi archive disks. * - * @return this. + * @return {@code this} instance. */ public Builder setMaxNumberOfDisks(final long maxNumberOfDisks) { this.maxNumberOfDisks = maxNumberOfDisks; @@ -190,7 +190,7 @@ public class ZipFile implements Closeable { * The actual channel, overrides any other input aspects like a File, Path, and so on. * * @param seekableByteChannel The actual channel. - * @return this. + * @return {@code this} instance. */ public Builder setSeekableByteChannel(final SeekableByteChannel seekableByteChannel) { this.seekableByteChannel = seekableByteChannel; @@ -201,7 +201,7 @@ public class ZipFile implements Closeable { * Sets whether to use InfoZIP Unicode Extra Fields (if present) to set the file names. * * @param useUnicodeExtraFields whether to use InfoZIP Unicode Extra Fields (if present) to set the file names. - * @return this. + * @return {@code this} instance. */ public Builder setUseUnicodeExtraFields(final boolean useUnicodeExtraFields) { this.useUnicodeExtraFields = useUnicodeExtraFields;