You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/02/10 21:32:01 UTC

(commons-compress) 04/07: Javadoc

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

commit f1ce1241faedc4eea7fd8d9951f7512346eaa956
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Feb 10 16:23:27 2024 -0500

    Javadoc
    
    Format tweak
---
 .../compress/archivers/zip/ExtraFieldParsingBehavior.java    |  7 +++----
 .../commons/compress/archivers/zip/ZipArchiveEntry.java      | 12 ++++--------
 2 files changed, 7 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
index 30cf205d1..dade47944 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
@@ -24,9 +24,9 @@ import java.util.zip.ZipException;
  * @since 1.19
  */
 public interface ExtraFieldParsingBehavior extends UnparseableExtraFieldBehavior {
+
     /**
      * Creates an instance of ZipExtraField for the given id.
-     *
      * <p>
      * A good default implementation would be {@link ExtraFieldUtils#createExtraField}.
      * </p>
@@ -34,14 +34,13 @@ public interface ExtraFieldParsingBehavior extends UnparseableExtraFieldBehavior
      * @param headerId the id for the extra field
      * @return an instance of ZipExtraField, must not be {@code null}
      * @throws ZipException           if an error occurs
-     * @throws InstantiationException if unable to instantiate the class
-     * @throws IllegalAccessException if not allowed to instantiate the class
+     * @throws InstantiationException if unable to instantiate the class, not thrown by Commons Compress.
+     * @throws IllegalAccessException if not allowed to instantiate the class, not thrown by Commons Compress.
      */
     ZipExtraField createExtraField(ZipShort headerId) throws ZipException, InstantiationException, IllegalAccessException;
 
     /**
      * Fills in the extra field data for a single extra field.
-     *
      * <p>
      * A good default implementation would be {@link ExtraFieldUtils#fillExtraField}.
      * </p>
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 71ed48aae..17e7383a0 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
@@ -1104,8 +1104,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry implements ArchiveEn
         }
     }
 
-    private ZipExtraField[] parseExtraFields(final byte[] data, final boolean local,
-                                             final ExtraFieldParsingBehavior parsingBehavior) throws ZipException {
+    private ZipExtraField[] parseExtraFields(final byte[] data, final boolean local, final ExtraFieldParsingBehavior parsingBehavior) throws ZipException {
         if (extraFieldFactory != null) {
             return ExtraFieldUtils.parse(data, local, new ExtraFieldParsingBehavior() {
                 @Override
@@ -1115,16 +1114,13 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry implements ArchiveEn
                 }
 
                 @Override
-                public ZipExtraField fill(final ZipExtraField field,
-                                          final byte[] data, final int off, final int len,
-                                          final boolean local) throws ZipException {
+                public ZipExtraField fill(final ZipExtraField field, final byte[] data, final int off, final int len, final boolean local) throws ZipException {
                     return parsingBehavior.fill(field, data, off, len, local);
                 }
 
                 @Override
-                public ZipExtraField onUnparseableExtraField(
-                        final byte[] data, final int off, final int len,
-                        final boolean local, final int claimedLength) throws ZipException {
+                public ZipExtraField onUnparseableExtraField(final byte[] data, final int off, final int len, final boolean local, final int claimedLength)
+                        throws ZipException {
                     return parsingBehavior.onUnparseableExtraField(data, off, len, local, claimedLength);
                 }
             });