Deprecate org.wildfly.common.ref in favor of SmallRye

Fixes #98

pom.xml

@@ -113,6 +113,10 @@
             <groupId>io.smallrye.common</groupId>
             <artifactId>smallrye-common-os</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.smallrye.common</groupId>
+            <artifactId>smallrye-common-ref</artifactId>
+        </dependency>
         <dependency>
             <!-- This dependency is just for javadoc -->
             <groupId>javax.annotation</groupId>

src/main/java/org/wildfly/common/ref/CleanerReference.java

@@ -18,6 +18,7 @@
 
 package org.wildfly.common.ref;
 
+import java.lang.ref.Cleaner;
 import java.util.Collections;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
@@ -26,7 +27,10 @@
  * A special version of {@link PhantomReference} that is strongly retained until it is reaped by the collection thread.
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link Cleaner} or {@link io.smallrye.common.ref.CleanerReference} instead.
  */
+@Deprecated(forRemoval = true)
 public class CleanerReference<T, A> extends PhantomReference<T, A> {
     private static final Set<CleanerReference<?, ?>> set = Collections.newSetFromMap(new ConcurrentHashMap<CleanerReference<?, ?>, Boolean>());
 

src/main/java/org/wildfly/common/ref/PhantomReference.java

@@ -30,7 +30,10 @@
  * @see java.lang.ref.PhantomReference
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.PhantomReference} instead.
  */
+@Deprecated(forRemoval = true)
 public class PhantomReference<T, A> extends java.lang.ref.PhantomReference<T> implements Reference<T, A>, Reapable<T, A> {
     private final A attachment;
     private final Reaper<T, A> reaper;

src/main/java/org/wildfly/common/ref/Reaper.java

@@ -25,7 +25,10 @@
  * @param <A> the reference attachment type
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.Reaper} instead.
  */
+@Deprecated(forRemoval = true)
 public interface Reaper<T, A> {
 
     /**

src/main/java/org/wildfly/common/ref/Reference.java

@@ -29,7 +29,10 @@
  * @see java.lang.ref.Reference
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.Reference} instead.
  */
+@Deprecated(forRemoval = true)
 public interface Reference<T, A> {
 
     /**

src/main/java/org/wildfly/common/ref/References.java

@@ -28,7 +28,10 @@
 
 /**
  * A set of utility methods for reference types.
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.References} instead.
  */
+@Deprecated(forRemoval = true)
 public final class References {
     private References() {
     }

src/main/java/org/wildfly/common/ref/SoftReference.java

@@ -30,6 +30,8 @@
  * @see java.lang.ref.SoftReference
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.SoftReference} instead.
  */
 public class SoftReference<T, A> extends java.lang.ref.SoftReference<T> implements Reference<T, A>, Reapable<T, A> {
     private final A attachment;

src/main/java/org/wildfly/common/ref/StrongReference.java

@@ -25,7 +25,10 @@
  * @param <A> the attachment type
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.StrongReference} instead.
  */
+@Deprecated(forRemoval = true)
 public class StrongReference<T, A> implements Reference<T, A> {
 
     private volatile T referent;

src/main/java/org/wildfly/common/ref/WeakReference.java

@@ -30,7 +30,10 @@
  * @see java.lang.ref.WeakReference
  *
  * @author <a href="mailto:[email protected]">David M. Lloyd</a>
+ *
+ * @deprecated Use {@link io.smallrye.common.ref.WeakReference} instead.
  */
+@Deprecated(forRemoval = true)
 public class WeakReference<T, A> extends java.lang.ref.WeakReference<T> implements Reference<T, A>, Reapable<T, A> {
     private final A attachment;
     private final Reaper<T, A> reaper;

src/main/java/org/wildfly/common/ref/package-info.java

@@ -19,5 +19,8 @@
 /**
  * Classes which implement reference types which can be cleaned up automatically by a background thread.  See
  * {@link org.wildfly.common.ref.Reference Reference} and its subtypes, and {@link org.wildfly.common.ref.Reaper Reaper} for more information.
+ *
+ * @deprecated Use {@link io.smallrye.common.ref} instead.
  */
+@Deprecated(forRemoval = true)
 package org.wildfly.common.ref;