Skip to content

Commit 166221b

Browse files
oldratleeoldratlee
committed
= improve javadoc
1 parent 8433cd3 commit 166221b

File tree

2 files changed

+57
-19
lines changed

2 files changed

+57
-19
lines changed

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

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
package com.alibaba.dcm;
22

3-
import com.alibaba.dcm.internal.*;
3+
import com.alibaba.dcm.internal.InetAddressCacheUtilCommons;
4+
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava8Minus;
5+
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava9Plus;
6+
import sun.net.InetAddressCachePolicy;
47

8+
import javax.annotation.Nonnull;
9+
import javax.annotation.Nullable;
510
import java.io.InputStream;
611
import java.util.Arrays;
712
import java.util.List;
813
import java.util.Map;
914
import java.util.Properties;
1015
import java.util.regex.Pattern;
1116

12-
import javax.annotation.Nonnull;
13-
import javax.annotation.Nullable;
14-
1517
import static com.alibaba.dcm.internal.InetAddressCacheUtilCommons.NEVER_EXPIRATION;
1618
import static com.alibaba.dcm.internal.JavaVersionUtil.isJdkAtMost8;
1719

@@ -265,12 +267,15 @@ public static void clearDnsCache() {
265267
* Get JVM DNS cache policy.
266268
*
267269
* @return cache seconds.
268-
* <p>
269270
* <ul>
270-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
271-
* <li> {@code 0} never cached.</li>
271+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
272+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
272273
* </ul>
273274
* @throws DnsCacheManipulatorException Operation fail
275+
* @see InetAddressCachePolicy#get()
276+
* @see InetAddressCachePolicy#FOREVER
277+
* @see InetAddressCachePolicy#NEVER
278+
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
274279
* @since 1.3.0
275280
*/
276281
public static int getDnsCachePolicy() {
@@ -288,10 +293,16 @@ public static int getDnsCachePolicy() {
288293
*
289294
* @param cacheSeconds set default dns cache time. Special input case:
290295
* <ul>
291-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
292-
* <li> {@code 0} never cached.</li>
296+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
297+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
293298
* </ul>
294299
* @throws DnsCacheManipulatorException Operation fail
300+
* @see InetAddressCachePolicy
301+
* @see InetAddressCachePolicy#cachePolicy
302+
* @see InetAddressCachePolicy#get()
303+
* @see InetAddressCachePolicy#FOREVER
304+
* @see InetAddressCachePolicy#NEVER
305+
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
295306
* @since 1.3.0
296307
*/
297308
public static void setDnsCachePolicy(int cacheSeconds) {
@@ -308,10 +319,13 @@ public static void setDnsCachePolicy(int cacheSeconds) {
308319
* @return negative cache seconds.
309320
* <p>
310321
* <ul>
311-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
312-
* <li> {@code 0} never cached.</li>
322+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
323+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
313324
* </ul>
314325
* @throws DnsCacheManipulatorException Operation fail
326+
* @see InetAddressCachePolicy#getNegative()
327+
* @see InetAddressCachePolicy#FOREVER
328+
* @see InetAddressCachePolicy#NEVER
315329
* @since 1.3.0
316330
*/
317331
public static int getDnsNegativeCachePolicy() {
@@ -327,10 +341,13 @@ public static int getDnsNegativeCachePolicy() {
327341
*
328342
* @param negativeCacheSeconds set default dns cache time. Special input case:
329343
* <ul>
330-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
331-
* <li> {@code 0} never cached.</li>
344+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
345+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
332346
* </ul>
333347
* @throws DnsCacheManipulatorException Operation fail
348+
* @see InetAddressCachePolicy
349+
* @see InetAddressCachePolicy#FOREVER
350+
* @see InetAddressCachePolicy#NEVER
334351
* @since 1.3.0
335352
*/
336353
public static void setDnsNegativeCachePolicy(int negativeCacheSeconds) {

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

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,41 +31,62 @@ static InetAddress[] toInetAddressArray(String host, String[] ips) throws Unknow
3131
}
3232

3333
/**
34-
* Set JVM DNS cache policy
34+
* Set JVM DNS cache policy.
3535
*
3636
* @param cacheSeconds set default dns cache time. Special input case:
3737
* <ul>
38-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
39-
* <li> {@code 0} never cached.</li>
38+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
39+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
4040
* </ul>
4141
* @see InetAddressCachePolicy
4242
* @see InetAddressCachePolicy#cachePolicy
43+
* @see InetAddressCachePolicy#get()
44+
* @see InetAddressCachePolicy#FOREVER
45+
* @see InetAddressCachePolicy#NEVER
46+
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
4347
*/
4448
public static void setDnsCachePolicy(int cacheSeconds)
4549
throws NoSuchFieldException, IllegalAccessException {
4650
setCachePolicy0(false, cacheSeconds);
4751
}
4852

53+
/**
54+
* Get JVM DNS cache policy.
55+
*
56+
* @see InetAddressCachePolicy#get()
57+
* @see InetAddressCachePolicy#FOREVER
58+
* @see InetAddressCachePolicy#NEVER
59+
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
60+
*/
4961
public static int getDnsCachePolicy() {
5062
return InetAddressCachePolicy.get();
5163
}
5264

5365
/**
54-
* Set JVM DNS negative cache policy
66+
* Set JVM DNS negative cache policy.
5567
*
5668
* @param negativeCacheSeconds set default dns cache time. Special input case:
5769
* <ul>
58-
* <li> {@code -1} means never expired.(In effect, all negative value)</li>
59-
* <li> {@code 0} never cached.</li>
70+
* <li> {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)</li>
71+
* <li> {@link InetAddressCachePolicy#NEVER}(@code 0) never cached.</li>
6072
* </ul>
6173
* @see InetAddressCachePolicy
6274
* @see InetAddressCachePolicy#negativeCachePolicy
75+
* @see InetAddressCachePolicy#FOREVER
76+
* @see InetAddressCachePolicy#NEVER
6377
*/
6478
public static void setDnsNegativeCachePolicy(int negativeCacheSeconds)
6579
throws NoSuchFieldException, IllegalAccessException {
6680
setCachePolicy0(true, negativeCacheSeconds);
6781
}
6882

83+
/**
84+
* Get JVM DNS negative cache policy.
85+
*
86+
* @see InetAddressCachePolicy#getNegative()
87+
* @see InetAddressCachePolicy#FOREVER
88+
* @see InetAddressCachePolicy#NEVER
89+
*/
6990
public static int getDnsNegativeCachePolicy() {
7091
return InetAddressCachePolicy.getNegative();
7192
}

0 commit comments

Comments
 (0)