From b91dd0678d290a70817ddc44bb5ced2baed275fd Mon Sep 17 00:00:00 2001 From: Scott Mitchell Date: Thu, 9 Feb 2017 09:27:24 -0800 Subject: [PATCH] Resolver package is unstable Motivation: The resolver package had some changes late in the 4.1.CR phase and the intention was to mark this package as unstable until these interfaces solidify, but we forgot to mark the package and public classes with the unstable annotation. Modifications: - resolver package public interfaces and package-info should be annotated with @UnstableApi Result: The unstable nature of the resolver package is more clearly communicated. --- .../main/java/io/netty/resolver/AbstractAddressResolver.java | 2 ++ resolver/src/main/java/io/netty/resolver/AddressResolver.java | 2 ++ .../src/main/java/io/netty/resolver/AddressResolverGroup.java | 2 ++ .../src/main/java/io/netty/resolver/CompositeNameResolver.java | 2 ++ .../java/io/netty/resolver/DefaultAddressResolverGroup.java | 2 ++ .../src/main/java/io/netty/resolver/DefaultNameResolver.java | 2 ++ .../main/java/io/netty/resolver/InetSocketAddressResolver.java | 2 ++ resolver/src/main/java/io/netty/resolver/NameResolver.java | 2 ++ .../src/main/java/io/netty/resolver/NoopAddressResolver.java | 2 ++ .../main/java/io/netty/resolver/NoopAddressResolverGroup.java | 2 ++ .../src/main/java/io/netty/resolver/SimpleNameResolver.java | 2 ++ resolver/src/main/java/io/netty/resolver/package-info.java | 3 +++ 12 files changed, 25 insertions(+) diff --git a/resolver/src/main/java/io/netty/resolver/AbstractAddressResolver.java b/resolver/src/main/java/io/netty/resolver/AbstractAddressResolver.java index 35ed52e3a2..fa034d01eb 100644 --- a/resolver/src/main/java/io/netty/resolver/AbstractAddressResolver.java +++ b/resolver/src/main/java/io/netty/resolver/AbstractAddressResolver.java @@ -20,6 +20,7 @@ import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.Promise; import io.netty.util.internal.TypeParameterMatcher; +import io.netty.util.internal.UnstableApi; import java.net.SocketAddress; import java.nio.channels.UnsupportedAddressTypeException; @@ -31,6 +32,7 @@ import static io.netty.util.internal.ObjectUtil.checkNotNull; /** * A skeletal {@link AddressResolver} implementation. */ +@UnstableApi public abstract class AbstractAddressResolver implements AddressResolver { private final EventExecutor executor; diff --git a/resolver/src/main/java/io/netty/resolver/AddressResolver.java b/resolver/src/main/java/io/netty/resolver/AddressResolver.java index adb613a50a..042affd750 100644 --- a/resolver/src/main/java/io/netty/resolver/AddressResolver.java +++ b/resolver/src/main/java/io/netty/resolver/AddressResolver.java @@ -17,6 +17,7 @@ package io.netty.resolver; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.io.Closeable; import java.net.SocketAddress; @@ -26,6 +27,7 @@ import java.util.List; /** * Resolves a possibility unresolved {@link SocketAddress}. */ +@UnstableApi public interface AddressResolver extends Closeable { /** diff --git a/resolver/src/main/java/io/netty/resolver/AddressResolverGroup.java b/resolver/src/main/java/io/netty/resolver/AddressResolverGroup.java index 509475eb3e..bd1a34664e 100644 --- a/resolver/src/main/java/io/netty/resolver/AddressResolverGroup.java +++ b/resolver/src/main/java/io/netty/resolver/AddressResolverGroup.java @@ -19,6 +19,7 @@ package io.netty.resolver; import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.FutureListener; +import io.netty.util.internal.UnstableApi; import io.netty.util.internal.logging.InternalLogger; import io.netty.util.internal.logging.InternalLoggerFactory; @@ -31,6 +32,7 @@ import java.util.concurrent.ConcurrentMap; /** * Creates and manages {@link NameResolver}s so that each {@link EventExecutor} has its own resolver instance. */ +@UnstableApi public abstract class AddressResolverGroup implements Closeable { private static final InternalLogger logger = InternalLoggerFactory.getInstance(AddressResolverGroup.class); diff --git a/resolver/src/main/java/io/netty/resolver/CompositeNameResolver.java b/resolver/src/main/java/io/netty/resolver/CompositeNameResolver.java index 7f5abdf0d7..24f41e12a2 100644 --- a/resolver/src/main/java/io/netty/resolver/CompositeNameResolver.java +++ b/resolver/src/main/java/io/netty/resolver/CompositeNameResolver.java @@ -19,6 +19,7 @@ import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.FutureListener; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.util.Arrays; import java.util.List; @@ -30,6 +31,7 @@ import static io.netty.util.internal.ObjectUtil.*; * * In case of a failure, only the last one will be reported. */ +@UnstableApi public final class CompositeNameResolver extends SimpleNameResolver { private final NameResolver[] resolvers; diff --git a/resolver/src/main/java/io/netty/resolver/DefaultAddressResolverGroup.java b/resolver/src/main/java/io/netty/resolver/DefaultAddressResolverGroup.java index 1b6fb53178..9e22b8fe3b 100644 --- a/resolver/src/main/java/io/netty/resolver/DefaultAddressResolverGroup.java +++ b/resolver/src/main/java/io/netty/resolver/DefaultAddressResolverGroup.java @@ -17,12 +17,14 @@ package io.netty.resolver; import io.netty.util.concurrent.EventExecutor; +import io.netty.util.internal.UnstableApi; import java.net.InetSocketAddress; /** * A {@link AddressResolverGroup} of {@link DefaultNameResolver}s. */ +@UnstableApi public final class DefaultAddressResolverGroup extends AddressResolverGroup { public static final DefaultAddressResolverGroup INSTANCE = new DefaultAddressResolverGroup(); diff --git a/resolver/src/main/java/io/netty/resolver/DefaultNameResolver.java b/resolver/src/main/java/io/netty/resolver/DefaultNameResolver.java index 38ae0eba24..d6d3aea46e 100644 --- a/resolver/src/main/java/io/netty/resolver/DefaultNameResolver.java +++ b/resolver/src/main/java/io/netty/resolver/DefaultNameResolver.java @@ -19,6 +19,7 @@ package io.netty.resolver; import io.netty.util.internal.SocketUtils; import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.net.InetAddress; import java.net.UnknownHostException; @@ -29,6 +30,7 @@ import java.util.List; * A {@link InetNameResolver} that resolves using JDK's built-in domain name lookup mechanism. * Note that this resolver performs a blocking name lookup from the caller thread. */ +@UnstableApi public class DefaultNameResolver extends InetNameResolver { public DefaultNameResolver(EventExecutor executor) { diff --git a/resolver/src/main/java/io/netty/resolver/InetSocketAddressResolver.java b/resolver/src/main/java/io/netty/resolver/InetSocketAddressResolver.java index 7f5f5b220b..c7db25d10d 100644 --- a/resolver/src/main/java/io/netty/resolver/InetSocketAddressResolver.java +++ b/resolver/src/main/java/io/netty/resolver/InetSocketAddressResolver.java @@ -19,6 +19,7 @@ import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.FutureListener; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.net.InetAddress; import java.net.InetSocketAddress; @@ -28,6 +29,7 @@ import java.util.List; /** * A {@link AbstractAddressResolver} that resolves {@link InetSocketAddress}. */ +@UnstableApi public class InetSocketAddressResolver extends AbstractAddressResolver { final NameResolver nameResolver; diff --git a/resolver/src/main/java/io/netty/resolver/NameResolver.java b/resolver/src/main/java/io/netty/resolver/NameResolver.java index 818122c4af..53a56b40b8 100644 --- a/resolver/src/main/java/io/netty/resolver/NameResolver.java +++ b/resolver/src/main/java/io/netty/resolver/NameResolver.java @@ -18,6 +18,7 @@ package io.netty.resolver; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.io.Closeable; import java.util.List; @@ -25,6 +26,7 @@ import java.util.List; /** * Resolves an arbitrary string that represents the name of an endpoint into an address. */ +@UnstableApi public interface NameResolver extends Closeable { /** diff --git a/resolver/src/main/java/io/netty/resolver/NoopAddressResolver.java b/resolver/src/main/java/io/netty/resolver/NoopAddressResolver.java index c34bb576f0..95514696a8 100644 --- a/resolver/src/main/java/io/netty/resolver/NoopAddressResolver.java +++ b/resolver/src/main/java/io/netty/resolver/NoopAddressResolver.java @@ -18,6 +18,7 @@ package io.netty.resolver; import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.net.SocketAddress; import java.util.Collections; @@ -27,6 +28,7 @@ import java.util.List; * A {@link AddressResolver} that does not perform any resolution but always reports successful resolution. * This resolver is useful when name resolution is performed by a handler in a pipeline, such as a proxy handler. */ +@UnstableApi public class NoopAddressResolver extends AbstractAddressResolver { public NoopAddressResolver(EventExecutor executor) { diff --git a/resolver/src/main/java/io/netty/resolver/NoopAddressResolverGroup.java b/resolver/src/main/java/io/netty/resolver/NoopAddressResolverGroup.java index 980cc50d8e..7727652e1f 100644 --- a/resolver/src/main/java/io/netty/resolver/NoopAddressResolverGroup.java +++ b/resolver/src/main/java/io/netty/resolver/NoopAddressResolverGroup.java @@ -17,12 +17,14 @@ package io.netty.resolver; import io.netty.util.concurrent.EventExecutor; +import io.netty.util.internal.UnstableApi; import java.net.SocketAddress; /** * A {@link AddressResolverGroup} of {@link NoopAddressResolver}s. */ +@UnstableApi public final class NoopAddressResolverGroup extends AddressResolverGroup { public static final NoopAddressResolverGroup INSTANCE = new NoopAddressResolverGroup(); diff --git a/resolver/src/main/java/io/netty/resolver/SimpleNameResolver.java b/resolver/src/main/java/io/netty/resolver/SimpleNameResolver.java index c8af37a4e3..923530f1a3 100644 --- a/resolver/src/main/java/io/netty/resolver/SimpleNameResolver.java +++ b/resolver/src/main/java/io/netty/resolver/SimpleNameResolver.java @@ -19,6 +19,7 @@ package io.netty.resolver; import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.Promise; +import io.netty.util.internal.UnstableApi; import java.util.List; @@ -27,6 +28,7 @@ import static io.netty.util.internal.ObjectUtil.*; /** * A skeletal {@link NameResolver} implementation. */ +@UnstableApi public abstract class SimpleNameResolver implements NameResolver { private final EventExecutor executor; diff --git a/resolver/src/main/java/io/netty/resolver/package-info.java b/resolver/src/main/java/io/netty/resolver/package-info.java index a92459842a..0dd9ab2a3c 100644 --- a/resolver/src/main/java/io/netty/resolver/package-info.java +++ b/resolver/src/main/java/io/netty/resolver/package-info.java @@ -17,4 +17,7 @@ /** * Resolves an arbitrary string that represents the name of an endpoint into an address. */ +@UnstableApi package io.netty.resolver; + +import io.netty.util.internal.UnstableApi;