applied LGPLv3 and source code formatting.

[vamsas.git] / src / org / apache / tools / zip / ZipExtraField.java

diff --git a/src/org/apache/tools/zip/ZipExtraField.java b/src/org/apache/tools/zip/ZipExtraField.java
index 622ff17..a755cd7 100644 (file)
--- a/src/org/apache/tools/zip/ZipExtraField.java
+++ b/src/org/apache/tools/zip/ZipExtraField.java
@@ -22,64 +22,75 @@ import java.util.zip.ZipException;
 
 /**
  * General format of extra field data.
- *
- * <p>Extra fields usually appear twice per file, once in the local
- * file data and once in the central directory.  Usually they are the
- * same, but they don't have to be.  {@link
- * java.util.zip.ZipOutputStream java.util.zip.ZipOutputStream} will
- * only use the local file data in both places.</p>
- *
+ * 
+ * <p>
+ * Extra fields usually appear twice per file, once in the local file data and
+ * once in the central directory. Usually they are the same, but they don't have
+ * to be. {@link java.util.zip.ZipOutputStream java.util.zip.ZipOutputStream}
+ * will only use the local file data in both places.
+ * </p>
+ * 
  */
 public interface ZipExtraField {
 
-    /**
-     * The Header-ID.
-     * @return the header id
-     * @since 1.1
-     */
-    ZipShort getHeaderId();
+  /**
+   * The Header-ID.
+   * 
+   * @return the header id
+   * @since 1.1
+   */
+  ZipShort getHeaderId();
 
-    /**
-     * Length of the extra field in the local file data - without
-     * Header-ID or length specifier.
-     * @return the length of the field in the local file data
-     * @since 1.1
-     */
-    ZipShort getLocalFileDataLength();
+  /**
+   * Length of the extra field in the local file data - without Header-ID or
+   * length specifier.
+   * 
+   * @return the length of the field in the local file data
+   * @since 1.1
+   */
+  ZipShort getLocalFileDataLength();
 
-    /**
-     * Length of the extra field in the central directory - without
-     * Header-ID or length specifier.
-     * @return the length of the field in the central directory
-     * @since 1.1
-     */
-    ZipShort getCentralDirectoryLength();
+  /**
+   * Length of the extra field in the central directory - without Header-ID or
+   * length specifier.
+   * 
+   * @return the length of the field in the central directory
+   * @since 1.1
+   */
+  ZipShort getCentralDirectoryLength();
 
-    /**
-     * The actual data to put into local file data - without Header-ID
-     * or length specifier.
-     * @return the data
-     * @since 1.1
-     */
-    byte[] getLocalFileDataData();
+  /**
+   * The actual data to put into local file data - without Header-ID or length
+   * specifier.
+   * 
+   * @return the data
+   * @since 1.1
+   */
+  byte[] getLocalFileDataData();
 
-    /**
-     * The actual data to put central directory - without Header-ID or
-     * length specifier.
-     * @return the data
-     * @since 1.1
-     */
-    byte[] getCentralDirectoryData();
+  /**
+   * The actual data to put central directory - without Header-ID or length
+   * specifier.
+   * 
+   * @return the data
+   * @since 1.1
+   */
+  byte[] getCentralDirectoryData();
 
-    /**
-     * Populate data from this array as if it was in local file data.
-     * @param data an array of bytes
-     * @param offset the start offset
-     * @param length the number of bytes in the array from offset
-     *
-     * @since 1.1
-     * @throws ZipException on error
-     */
-    void parseFromLocalFileData(byte[] data, int offset, int length)
-        throws ZipException;
+  /**
+   * Populate data from this array as if it was in local file data.
+   * 
+   * @param data
+   *          an array of bytes
+   * @param offset
+   *          the start offset
+   * @param length
+   *          the number of bytes in the array from offset
+   * 
+   * @since 1.1
+   * @throws ZipException
+   *           on error
+   */
+  void parseFromLocalFileData(byte[] data, int offset, int length)
+      throws ZipException;
 }