Skip to content

Commit 52a367a

Browse files
oldratleeoldratlee
committed
refactor: use @*AreNonnullByDefault instead of @Nonnull, less noisy
1 parent aa4a5f0 commit 52a367a

File tree

6 files changed

+36
-22
lines changed

6 files changed

+36
-22
lines changed

‎library/src/main/java/com/alibaba/dcm/DnsCache.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
package com.alibaba.dcm;
22

3+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
34
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
45

5-
import javax.annotation.Nonnull;
6+
import javax.annotation.ParametersAreNonnullByDefault;
67
import javax.annotation.concurrent.Immutable;
78
import java.io.Serializable;
89
import java.util.ArrayList;
@@ -16,6 +17,8 @@
1617
* @since 1.2.0
1718
*/
1819
@Immutable
20+
@ParametersAreNonnullByDefault
21+
@ReturnValuesAreNonnullByDefault
1922
public class DnsCache implements Serializable {
2023
private static final long serialVersionUID = -8614746635950970028L;
2124

@@ -25,8 +28,8 @@ public class DnsCache implements Serializable {
2528
/**
2629
* Construct a {@link DnsCache}.
2730
*/
28-
public DnsCache(@SuppressFBWarnings("EI_EXPOSE_REP2") @Nonnull List<DnsCacheEntry> cache,
29-
@SuppressFBWarnings("EI_EXPOSE_REP2") @Nonnull List<DnsCacheEntry> negativeCache) {
31+
public DnsCache(@SuppressFBWarnings("EI_EXPOSE_REP2") List<DnsCacheEntry> cache,
32+
@SuppressFBWarnings("EI_EXPOSE_REP2") List<DnsCacheEntry> negativeCache) {
3033
this.cache = cache;
3134
this.negativeCache = negativeCache;
3235
}

‎library/src/main/java/com/alibaba/dcm/DnsCacheEntry.java‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
package com.alibaba.dcm;
22

3+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
34
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
45

5-
import javax.annotation.Nonnull;
6+
import javax.annotation.ParametersAreNonnullByDefault;
67
import javax.annotation.concurrent.Immutable;
78
import java.io.Serializable;
89
import java.text.SimpleDateFormat;
@@ -16,6 +17,8 @@
1617
* @see DnsCache
1718
*/
1819
@Immutable
20+
@ParametersAreNonnullByDefault
21+
@ReturnValuesAreNonnullByDefault
1922
public final class DnsCacheEntry implements Serializable {
2023
private static final long serialVersionUID = -7476648934387757732L;
2124

@@ -33,7 +36,6 @@ public String getHost() {
3336
/**
3437
* get ips of DNS cache entry(DNS record).
3538
*/
36-
@Nonnull
3739
public String[] getIps() {
3840
return ips.clone(); // defensive copy
3941
}
@@ -61,8 +63,8 @@ public Date getExpiration() {
6163
*/
6264
@Deprecated
6365
public DnsCacheEntry(String host,
64-
@Nonnull @SuppressFBWarnings("EI_EXPOSE_REP2") String[] ips,
65-
@Nonnull @SuppressFBWarnings("EI_EXPOSE_REP2") Date expiration) {
66+
@SuppressFBWarnings("EI_EXPOSE_REP2") String[] ips,
67+
@SuppressFBWarnings("EI_EXPOSE_REP2") Date expiration) {
6668
this.host = host;
6769
this.ips = ips;
6870
this.expiration = expiration.getTime();
@@ -74,7 +76,7 @@ public DnsCacheEntry(String host,
7476
* @since 1.6.0
7577
*/
7678
public DnsCacheEntry(String host,
77-
@Nonnull @SuppressFBWarnings("EI_EXPOSE_REP2") String[] ips,
79+
@SuppressFBWarnings("EI_EXPOSE_REP2") String[] ips,
7880
long expiration) {
7981
this.host = host;
8082
this.ips = ips;

‎library/src/main/java/com/alibaba/dcm/DnsCacheManipulator.java‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
import com.alibaba.dcm.internal.InetAddressCacheUtilCommons;
44
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava8Minus;
55
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava9Plus;
6+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
67
import sun.net.InetAddressCachePolicy;
78

8-
import javax.annotation.Nonnull;
99
import javax.annotation.Nullable;
10+
import javax.annotation.ParametersAreNonnullByDefault;
1011
import java.io.InputStream;
1112
import java.util.Arrays;
1213
import java.util.List;
@@ -28,6 +29,8 @@
2829
* @see DnsCacheEntry
2930
* @see DnsCacheManipulatorException
3031
*/
32+
@ParametersAreNonnullByDefault
33+
@ReturnValuesAreNonnullByDefault
3134
public class DnsCacheManipulator {
3235
/**
3336
* Set a <b>never expired</b> dns cache entry.
@@ -37,7 +40,7 @@ public class DnsCacheManipulator {
3740
* @throws DnsCacheManipulatorException Operation fail
3841
* @see DnsCacheManipulator#setDnsCache(long, java.lang.String, java.lang.String...)
3942
*/
40-
public static void setDnsCache(@Nonnull String host, @Nonnull String... ips) {
43+
public static void setDnsCache(String host, String... ips) {
4144
try {
4245
if (isJdkAtMost8()) {
4346
InetAddressCacheUtilForJava8Minus.setInetAddressCache(host, ips, NEVER_EXPIRATION);
@@ -59,7 +62,7 @@ public static void setDnsCache(@Nonnull String host, @Nonnull String... ips) {
5962
* @param ips ips
6063
* @throws DnsCacheManipulatorException Operation fail
6164
*/
62-
public static void setDnsCache(long expireMillis, @Nonnull String host, @Nonnull String... ips) {
65+
public static void setDnsCache(long expireMillis, String host, String... ips) {
6366
try {
6467
if (isJdkAtMost8()) {
6568
InetAddressCacheUtilForJava8Minus.setInetAddressCache(host, ips, expireMillis);
@@ -84,7 +87,7 @@ public static void setDnsCache(long expireMillis, @Nonnull String host, @Nonnull
8487
* {@code www.example.com=42.42.42.42,43.43.43.43}
8588
* @throws DnsCacheManipulatorException Operation fail
8689
*/
87-
public static void setDnsCache(@Nonnull Properties properties) {
90+
public static void setDnsCache(Properties properties) {
8891
for (Map.Entry<Object, Object> entry : properties.entrySet()) {
8992
final String host = (String) entry.getKey();
9093
String ipList = (String) entry.getValue();
@@ -119,7 +122,7 @@ public static void loadDnsCacheConfig() {
119122
* @throws DnsCacheManipulatorException Operation fail
120123
* @see DnsCacheManipulator#setDnsCache(java.util.Properties)
121124
*/
122-
public static void loadDnsCacheConfig(@Nonnull String propertiesFileName) {
125+
public static void loadDnsCacheConfig(String propertiesFileName) {
123126
InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(propertiesFileName);
124127
if (inputStream == null) {
125128
inputStream = DnsCacheManipulator.class.getClassLoader().getResourceAsStream(propertiesFileName);
@@ -147,7 +150,7 @@ public static void loadDnsCacheConfig(@Nonnull String propertiesFileName) {
147150
* @throws DnsCacheManipulatorException Operation fail
148151
*/
149152
@Nullable
150-
public static DnsCacheEntry getDnsCache(@Nonnull String host) {
153+
public static DnsCacheEntry getDnsCache(String host) {
151154
try {
152155
if (isJdkAtMost8()) {
153156
return InetAddressCacheUtilForJava8Minus.getInetAddressCache(host);
@@ -169,7 +172,6 @@ public static DnsCacheEntry getDnsCache(@Nonnull String host) {
169172
* @see #listDnsCache()
170173
* @since 1.2.0
171174
*/
172-
@Nonnull
173175
public static DnsCache getWholeDnsCache() {
174176
try {
175177
if (isJdkAtMost8()) {
@@ -192,7 +194,6 @@ public static DnsCache getWholeDnsCache() {
192194
* @see #getWholeDnsCache()
193195
* @since 1.2.0
194196
*/
195-
@Nonnull
196197
public static List<DnsCacheEntry> listDnsCache() {
197198
return getWholeDnsCache().getCache();
198199
}
@@ -205,7 +206,6 @@ public static List<DnsCacheEntry> listDnsCache() {
205206
* @deprecated this method name is confused: method name is "all" but without negative cache.
206207
* use {@link #listDnsCache} instead.
207208
*/
208-
@Nonnull
209209
@Deprecated
210210
public static List<DnsCacheEntry> getAllDnsCache() {
211211
return listDnsCache();
@@ -221,7 +221,6 @@ public static List<DnsCacheEntry> getAllDnsCache() {
221221
* @see #getWholeDnsCache()
222222
* @since 1.6.0
223223
*/
224-
@Nonnull
225224
public static List<DnsCacheEntry> listDnsNegativeCache() {
226225
return getWholeDnsCache().getNegativeCache();
227226
}
@@ -233,7 +232,7 @@ public static List<DnsCacheEntry> listDnsNegativeCache() {
233232
* @throws DnsCacheManipulatorException Operation fail
234233
* @see DnsCacheManipulator#clearDnsCache
235234
*/
236-
public static void removeDnsCache(@Nonnull String host) {
235+
public static void removeDnsCache(String host) {
237236
try {
238237
if (isJdkAtMost8()) {
239238
InetAddressCacheUtilForJava8Minus.removeInetAddressCache(host);

‎library/src/main/java/com/alibaba/dcm/internal/InetAddressCacheUtilCommons.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
package com.alibaba.dcm.internal;
22

3+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
34
import sun.net.InetAddressCachePolicy;
45

5-
import javax.annotation.Nonnull;
66
import javax.annotation.Nullable;
7+
import javax.annotation.ParametersAreNonnullByDefault;
78
import java.lang.reflect.Field;
89
import java.net.InetAddress;
910
import java.net.UnknownHostException;
@@ -14,6 +15,8 @@
1415
* @author Jerry Lee (oldratlee at gmail dot com)
1516
* @since 1.6.0
1617
*/
18+
@ParametersAreNonnullByDefault
19+
@ReturnValuesAreNonnullByDefault
1720
public final class InetAddressCacheUtilCommons {
1821
/**
1922
* We never really have "never".
@@ -32,7 +35,6 @@ static InetAddress[] toInetAddressArray(String host, String[] ips) throws Unknow
3235
return addresses;
3336
}
3437

35-
@Nonnull
3638
static String[] getIpFromInetAddress(@Nullable InetAddress[] inetAddresses) {
3739
if (inetAddresses == null) return new String[0];
3840

‎library/src/main/java/com/alibaba/dcm/internal/InetAddressCacheUtilForJava8Minus.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
import com.alibaba.dcm.DnsCache;
44
import com.alibaba.dcm.DnsCacheEntry;
5+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
56

67
import javax.annotation.Nullable;
8+
import javax.annotation.ParametersAreNonnullByDefault;
79
import javax.annotation.concurrent.GuardedBy;
810
import java.lang.reflect.Constructor;
911
import java.lang.reflect.Field;
@@ -35,6 +37,8 @@
3537
* @see InetAddress#cacheInitIfNeeded()
3638
* @see InetAddress#cacheAddresses(String, InetAddress[], boolean)
3739
*/
40+
@ParametersAreNonnullByDefault
41+
@ReturnValuesAreNonnullByDefault
3842
public final class InetAddressCacheUtilForJava8Minus {
3943
/**
4044
* Need convert host to lowercase, see {@link InetAddress#cacheAddresses(String, InetAddress[], boolean)}.
@@ -205,7 +209,7 @@ public static DnsCacheEntry getInetAddressCache(String host)
205209
return dnsCacheEntry;
206210
}
207211

208-
private static boolean isDnsCacheEntryExpired(String host) {
212+
private static boolean isDnsCacheEntryExpired(@Nullable String host) {
209213
return null == host || "0.0.0.0".equals(host);
210214
}
211215

‎library/src/main/java/com/alibaba/dcm/internal/InetAddressCacheUtilForJava9Plus.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
import com.alibaba.dcm.DnsCache;
44
import com.alibaba.dcm.DnsCacheEntry;
5+
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
56

67
import javax.annotation.Nullable;
8+
import javax.annotation.ParametersAreNonnullByDefault;
79
import java.lang.reflect.Constructor;
810
import java.lang.reflect.Field;
911
import java.lang.reflect.InvocationTargetException;
@@ -29,6 +31,8 @@
2931
* @author Jerry Lee (oldratlee at gmail dot com)
3032
* @since 1.6.0
3133
*/
34+
@ParametersAreNonnullByDefault
35+
@ReturnValuesAreNonnullByDefault
3236
public final class InetAddressCacheUtilForJava9Plus {
3337
/**
3438
* {@link InetAddress.CachedAddresses}

0 commit comments

Comments
 (0)