feat: deprecate Readable#resource(String) and Writable#resource(String)

unnamed · Jan 2, 2024 · 4cb1b0c · 4cb1b0c
1 parent 44ebf23
commit 4cb1b0c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/api/src/main/java/team/unnamed/creative/base/Readable.java b/api/src/main/java/team/unnamed/creative/base/Readable.java
@@ -23,11 +23,18 @@
  */
 package team.unnamed.creative.base;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import sun.reflect.CallerSensitive;
 import sun.reflect.Reflection;
 
-import java.io.*;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.UncheckedIOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.OpenOption;
@@ -155,7 +162,10 @@ default void readAndWrite(final @NotNull OutputStream output) {
      * @param name The full resource name
      * @return The {@link Readable} representation
      * @since 1.1.0
+     * @deprecated Use {@link #resource(ClassLoader, String)} instead
      */
+    @Deprecated
+    @ApiStatus.ScheduledForRemoval(inVersion = "2.0.0")
     @CallerSensitive
     static @NotNull Readable resource(final @NotNull String name) {
         requireNonNull(name, "name");

diff --git a/api/src/main/java/team/unnamed/creative/base/Writable.java b/api/src/main/java/team/unnamed/creative/base/Writable.java
@@ -23,6 +23,7 @@
  */
 package team.unnamed.creative.base;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import sun.reflect.CallerSensitive;
 import sun.reflect.Reflection;
@@ -140,7 +141,10 @@ public String toString() {
      * @param name The full resource name
      * @return The {@link Writable} representation
      * @since 1.1.0
+     * @deprecated Use {@link #resource(ClassLoader, String)} instead
      */
+    @Deprecated
+    @ApiStatus.ScheduledForRemoval(inVersion = "2.0.0")
     @CallerSensitive
     static @NotNull Writable resource(final @NotNull String name) {
         requireNonNull(name, "name");