You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2019/08/17 10:28:12 UTC
[commons-compress] 02/03: javadoc warnings
This is an automated email from the ASF dual-hosted git repository.
bodewig pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit 6b8ae855e41aa1c0e7e07c72d384c5ce88f67999
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Fri Aug 16 18:14:33 2019 +0200
javadoc warnings
---
.../archivers/examples/CloseableConsumer.java | 5 +++++
.../compress/archivers/zip/ExtraFieldUtils.java | 25 +++++++++++++---------
.../zip/X0017_StrongEncryptionHeader.java | 2 ++
.../compress/archivers/zip/ZipArchiveEntry.java | 2 +-
4 files changed, 23 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java b/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java
index 670bf40..dead47f 100644
--- a/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java
+++ b/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java
@@ -53,6 +53,11 @@ public interface CloseableConsumer {
* Callback that is informed about a closable resource that has
* been wrapped around a passed in stream or channel by Expander
* or Archiver when Expander or Archiver no longer need them.
+ *
+ * @param c Closeable created by Expander or Archiver that is now
+ * no longer used
+ *
+ * @throws IOException on error
*/
void accept(Closeable c) throws IOException;
}
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
index 78f16ba..d0309e7 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
@@ -180,21 +180,16 @@ public class ExtraFieldUtils {
* Split the array into ExtraFields and populate them with the
* given data.
* @param data an array of bytes
+ * @param parsingBehavior controls parsing of extra fields.
* @param local whether data originates from the local file data
* or the central directory
- * @param onUnparseableData what to do if the extra field data
- * cannot be parsed.
- * @param onParseError what to do if the field's key is recognized
- * but our implementation class fails to handle it. If the key and
- * length cannot be parsed at all {@code onUnparseableData} will
- * determine the behavior.
* @return an array of ExtraFields
* @throws ZipException on error
*
* @since 1.19
*/
public static ZipExtraField[] parse(final byte[] data, final boolean local,
- final ExtraFieldParsingBehavior parsingbehavior)
+ final ExtraFieldParsingBehavior parsingBehavior)
throws ZipException {
final List<ZipExtraField> v = new ArrayList<>();
int start = 0;
@@ -203,7 +198,7 @@ public class ExtraFieldUtils {
final ZipShort headerId = new ZipShort(data, start);
final int length = new ZipShort(data, start + 2).getValue();
if (start + WORD + length > data.length) {
- ZipExtraField field = parsingbehavior.onUnparseableExtraField(data, start, data.length - start,
+ ZipExtraField field = parsingBehavior.onUnparseableExtraField(data, start, data.length - start,
local, length);
if (field != null) {
v.add(field);
@@ -214,9 +209,9 @@ public class ExtraFieldUtils {
break LOOP;
}
try {
- ZipExtraField ze = Objects.requireNonNull(parsingbehavior.createExtraField(headerId),
+ ZipExtraField ze = Objects.requireNonNull(parsingBehavior.createExtraField(headerId),
"createExtraField must not return null");
- v.add(Objects.requireNonNull(parsingbehavior.fill(ze, data, start + WORD, length, local),
+ v.add(Objects.requireNonNull(parsingBehavior.fill(ze, data, start + WORD, length, local),
"fill must not return null"));
start += length + WORD;
} catch (final InstantiationException | IllegalAccessException ie) {
@@ -310,6 +305,16 @@ public class ExtraFieldUtils {
*
* <p>Calls {@link ZipExtraField#parseFromCentralDirectoryData} or {@link ZipExtraField#parseFromLocalFileData} internally and wraps any {@link ArrayIndexOutOfBoundsException} thrown into a {@link ZipException}.</p>
*
+ * @param ze the extra field instance to fill
+ * @param data the array of extra field data
+ * @param off offset into data where this field's data starts
+ * @param len the length of this field's data
+ * @param local whether the extra field data stems from the local
+ * file header. If this is false then the data is part if the
+ * central directory header extra data.
+ * @return the filled field, will never be {@code null}
+ * @throws ZipException if an error occurs
+ *
* @since 1.19
*/
public static ZipExtraField fillExtraField(final ZipExtraField ze, final byte[] data, final int off,
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
index d3669e9..a9600a7 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
@@ -301,6 +301,7 @@ public class X0017_StrongEncryptionHeader extends PKWareExtraHeader {
* @param data the buffer to read data from
* @param offset offset into buffer to read data
* @param length the length of data
+ * @throws ZipException if an error occurs
*/
public void parseCentralDirectoryFormat(final byte[] data, final int offset, final int length)
throws ZipException {
@@ -333,6 +334,7 @@ public class X0017_StrongEncryptionHeader extends PKWareExtraHeader {
* @param data the buffer to read data from
* @param offset offset into buffer to read data
* @param length the length of data
+ * @throws ZipException if an error occurs
*/
public void parseFileFormat(final byte[] data, final int offset, final int length)
throws ZipException {
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
index 68b34b4..0412d21 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
@@ -447,7 +447,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
* @return an array of the extra fields
*
* @throws ZipException if parsing fails, can not happen if {@code
- * parsingBehavior} is {@link ExtraFieldParsingMode.BEST_EFFORT}.
+ * parsingBehavior} is {@link ExtraFieldParsingMode#BEST_EFFORT}.
*
* @since 1.19
*/