[MSHARED-1251] - Deprecate the JAR Index feature (JDK-8302819)

Signed-off-by: Jorge Solórzano <jorsol@gmail.com>
apache · Jul 25, 2023 · f4a9b51 · f4a9b51
1 parent ab0a1a3
commit f4a9b51
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/src/main/java/org/apache/maven/archiver/MavenArchiveConfiguration.java b/src/main/java/org/apache/maven/archiver/MavenArchiveConfiguration.java
@@ -35,6 +35,10 @@ public class MavenArchiveConfiguration {
 
     private boolean recompressAddedZips = true;
 
+    /**
+     * @deprecated See <a href="https://bugs.openjdk.org/browse/JDK-8305597">JDK-8305597</a>
+     */
+    @Deprecated
     private boolean index;
 
     private boolean addMavenDescriptor = true;
@@ -89,7 +93,9 @@ public void setRecompressAddedZips(boolean recompressAddedZips) {
      * <p>isIndex.</p>
      *
      * @return {@link #index}
+     * @deprecated See <a href="https://bugs.openjdk.org/browse/JDK-8305597">JDK-8305597</a>
      */
+    @Deprecated
     public boolean isIndex() {
         return index;
     }
@@ -138,7 +144,9 @@ public void setCompress(boolean compress) {
      * <p>Setter for the field <code>index</code>.</p>
      *
      * @param index set index to true/false.
+     * @deprecated See <a href="https://bugs.openjdk.org/browse/JDK-8305597">JDK-8305597</a>
      */
+    @Deprecated
     public void setIndex(boolean index) {
         this.index = index;
     }

diff --git a/src/site/xdoc/index.xml.vm b/src/site/xdoc/index.xml.vm
@@ -131,9 +131,14 @@
           <tr>
             <td>index</td>
             <td>
-              Whether the created archive will contain an
-              <code>INDEX.LIST</code> file.
-              The default value is <code>false</code>.
+              <strong>Deprecated:</strong> See <a href="https://bugs.openjdk.org/browse/JDK-8305597">JDK-8305597</a>
+              <p>
+                Whether the created archive will contain an
+                <code>INDEX.LIST</code> file.
+              </p>
+              <p>
+                The default value is <code>false</code>.
+              </p>
             </td>
             <td>boolean</td>
             <td></td>