8214567: Use {@systemProperty} for definitions of system properties
8214569: Use {@systemProperty} for definitions of system properties
Reviewed-by: lancea, mchung, alanb, naoto
Contributed-by: Deepak kejriwal <deepak.kejriwal@oracle.com>
--- a/src/java.base/share/classes/java/lang/ClassLoader.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/lang/ClassLoader.java Wed Dec 26 17:09:19 2018 +0530
@@ -1864,12 +1864,12 @@
* <p> The default system class loader is an implementation-dependent
* instance of this class.
*
- * <p> If the system property "{@code java.system.class.loader}" is defined
- * when this method is first invoked then the value of that property is
- * taken to be the name of a class that will be returned as the system
- * class loader. The class is loaded using the default system class loader
- * and must define a public constructor that takes a single parameter of
- * type {@code ClassLoader} which is used as the delegation parent. An
+ * <p> If the system property "{@systemProperty java.system.class.loader}"
+ * is defined when this method is first invoked then the value of that
+ * property is taken to be the name of a class that will be returned as the
+ * system class loader. The class is loaded using the default system class
+ * loader and must define a public constructor that takes a single parameter
+ * of type {@code ClassLoader} which is used as the delegation parent. An
* instance is then created using this constructor with the default system
* class loader as the parameter. The resulting class loader is defined
* to be the system class loader. During construction, the class loader
--- a/src/java.base/share/classes/java/net/URL.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/net/URL.java Wed Dec 26 17:09:19 2018 +0530
@@ -304,7 +304,7 @@
* or all providers have been exhausted.
* <li>If the previous step fails to find a protocol handler, the
* constructor reads the value of the system property:
- * <blockquote>{@code
+ * <blockquote>{@systemProperty
* java.protocol.handler.pkgs
* }</blockquote>
* If the value of that system property is not {@code null},
--- a/src/java.base/share/classes/java/time/zone/ZoneRulesProvider.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/time/zone/ZoneRulesProvider.java Wed Dec 26 17:09:19 2018 +0530
@@ -99,7 +99,7 @@
* <p>
* The Java virtual machine has a default provider that provides zone rules
* for the time-zones defined by IANA Time Zone Database (TZDB). If the system
- * property {@code java.time.zone.DefaultZoneRulesProvider} is defined then
+ * property {@systemProperty java.time.zone.DefaultZoneRulesProvider} is defined then
* it is taken to be the fully-qualified name of a concrete ZoneRulesProvider
* class to be loaded as the default provider, using the system class loader.
* If this system property is not defined, a system-default provider will be
--- a/src/java.base/share/classes/java/util/Currency.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/util/Currency.java Wed Dec 26 17:09:19 2018 +0530
@@ -60,7 +60,7 @@
* the <code>getInstance</code> methods.
* <p>
* Users can supersede the Java runtime currency data by means of the system
- * property {@code java.util.currency.data}. If this system property is
+ * property {@systemProperty java.util.currency.data}. If this system property is
* defined then its value is the location of a properties file, the contents of
* which are key/value pairs of the ISO 3166 country codes and the ISO 4217
* currency data respectively. The value part consists of three ISO 4217 values
--- a/src/java.base/share/classes/java/util/PropertyResourceBundle.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/util/PropertyResourceBundle.java Wed Dec 26 17:09:19 2018 +0530
@@ -115,7 +115,7 @@
* input stream, then the {@code PropertyResourceBundle} instance resets to the state
* before the exception, re-reads the input stream in {@code ISO-8859-1}, and
* continues reading. If the system property
- * {@code java.util.PropertyResourceBundle.encoding} is set to either
+ * {@systemProperty java.util.PropertyResourceBundle.encoding} is set to either
* "ISO-8859-1" or "UTF-8", the input stream is solely read in that encoding,
* and throws the exception if it encounters an invalid sequence.
* If "ISO-8859-1" is specified, characters that cannot be represented in
--- a/src/java.base/share/classes/java/util/jar/Pack200.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/util/jar/Pack200.java Wed Dec 26 17:09:19 2018 +0530
@@ -112,7 +112,7 @@
/**
* Obtain new instance of a class that implements Packer.
* <ul>
- * <li><p>If the system property {@code java.util.jar.Pack200.Packer}
+ * <li><p>If the system property {@systemProperty java.util.jar.Pack200.Packer}
* is defined, then the value is taken to be the fully-qualified name
* of a concrete implementation class, which must implement Packer.
* This class is loaded and instantiated. If this process fails
@@ -138,7 +138,7 @@
/**
* Obtain new instance of a class that implements Unpacker.
* <ul>
- * <li><p>If the system property {@code java.util.jar.Pack200.Unpacker}
+ * <li><p>If the system property {@systemProperty java.util.jar.Pack200.Unpacker}
* is defined, then the value is taken to be the fully-qualified
* name of a concrete implementation class, which must implement Unpacker.
* The class is loaded and instantiated. If this process fails
--- a/src/java.base/share/classes/java/util/spi/LocaleServiceProvider.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.base/share/classes/java/util/spi/LocaleServiceProvider.java Wed Dec 26 17:09:19 2018 +0530
@@ -113,7 +113,7 @@
* described above as if the locale was not supported.
* <p>
* The search order of locale sensitive services can
- * be configured by using the "java.locale.providers" system property.
+ * be configured by using the {@systemProperty java.locale.providers} system property.
* This system property declares the user's preferred order for looking up
* the locale sensitive services separated by a comma. It is only read at
* the Java runtime startup, so the later call to System.setProperty() won't
--- a/src/java.logging/share/classes/java/util/logging/LogManager.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.logging/share/classes/java/util/logging/LogManager.java Wed Dec 26 17:09:19 2018 +0530
@@ -76,8 +76,8 @@
* the initial configuration, as specified in the {@link #readConfiguration()}
* method:
* <ul>
- * <li>"java.util.logging.config.class"
- * <li>"java.util.logging.config.file"
+ * <li>{@systemProperty java.util.logging.config.class}
+ * <li>{@systemProperty java.util.logging.config.file}
* </ul>
* <p>
* These two system properties may be specified on the command line to the "java"
--- a/src/java.logging/share/classes/java/util/logging/SimpleFormatter.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.logging/share/classes/java/util/logging/SimpleFormatter.java Wed Dec 26 17:09:19 2018 +0530
@@ -39,7 +39,7 @@
* <a id="formatting">
* <b>Configuration:</b></a>
* The {@code SimpleFormatter} is initialized with the format string
- * specified in the {@code java.util.logging.SimpleFormatter.format}
+ * specified in the {@systemProperty java.util.logging.SimpleFormatter.format}
* property to {@linkplain #format(LogRecord) format} the log messages.
* This property can be defined
* in the {@linkplain LogManager#getProperty logging properties}
--- a/src/java.rmi/share/classes/java/rmi/server/ObjID.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.rmi/share/classes/java/rmi/server/ObjID.java Wed Dec 26 17:09:19 2018 +0530
@@ -57,7 +57,7 @@
* equivalent to one returned by invoking the {@link UID#UID(short)}
* constructor with the value zero.
*
- * <p>If the system property <code>java.rmi.server.randomIDs</code>
+ * <p>If the system property {@systemProperty java.rmi.server.randomIDs}
* is defined to equal the string <code>"true"</code> (case insensitive),
* then the {@link #ObjID()} constructor will use a cryptographically
* strong random number generator to choose the object number of the
--- a/src/java.rmi/share/classes/java/rmi/server/RMIClassLoader.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.rmi/share/classes/java/rmi/server/RMIClassLoader.java Wed Dec 26 17:09:19 2018 +0530
@@ -68,7 +68,7 @@
* <ul>
*
* <li>If the system property
- * <code>java.rmi.server.RMIClassLoaderSpi</code> is defined, then if
+ * {@systemProperty java.rmi.server.RMIClassLoaderSpi} is defined, then if
* its value equals the string <code>"default"</code>, the provider
* instance will be the value returned by an invocation of the {@link
* #getDefaultProviderInstance()} method, and for any other value, if
@@ -429,7 +429,7 @@
* system class loader such as the loader used for installed
* extensions, or the bootstrap class loader (which may be
* represented by <code>null</code>), then the value of the
- * <code>java.rmi.server.codebase</code> property (or possibly an
+ * {@systemProperty java.rmi.server.codebase} property (or possibly an
* earlier cached value) is returned, or
* <code>null</code> is returned if that property is not set.
*
--- a/src/java.rmi/share/classes/java/rmi/server/RMISocketFactory.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.rmi/share/classes/java/rmi/server/RMISocketFactory.java Wed Dec 26 17:09:19 2018 +0530
@@ -66,7 +66,7 @@
* RMISocketFactory.setSocketFactory(new LoopbackSocketFactory());
* }</pre>
*
- * Set the {@code java.rmi.server.hostname} system property
+ * Set the {@systemProperty java.rmi.server.hostname} system property
* to {@code 127.0.0.1} to ensure that the generated stubs connect to the right
* network interface.
*
--- a/src/java.rmi/share/classes/javax/rmi/ssl/SslRMIClientSocketFactory.java Sat Dec 22 15:47:10 2018 +0100
+++ b/src/java.rmi/share/classes/javax/rmi/ssl/SslRMIClientSocketFactory.java Wed Dec 26 17:09:19 2018 +0530
@@ -53,14 +53,14 @@
* #hashCode() hashCode} may also need to be overridden.</p>
*
* <p>If the system property
- * <code>javax.rmi.ssl.client.enabledCipherSuites</code> is specified,
+ * {@systemProperty javax.rmi.ssl.client.enabledCipherSuites} is specified,
* the {@link #createSocket(String,int)} method will call {@link
* SSLSocket#setEnabledCipherSuites(String[])} before returning the
* socket. The value of this system property is a string that is a
* comma-separated list of SSL/TLS cipher suites to enable.</p>
*
* <p>If the system property
- * <code>javax.rmi.ssl.client.enabledProtocols</code> is specified,
+ * {@systemProperty javax.rmi.ssl.client.enabledProtocols} is specified,
* the {@link #createSocket(String,int)} method will call {@link
* SSLSocket#setEnabledProtocols(String[])} before returning the
* socket. The value of this system property is a string that is a
@@ -96,7 +96,7 @@
* <p>Creates an SSL socket.</p>
*
* <p>If the system property
- * <code>javax.rmi.ssl.client.enabledCipherSuites</code> is
+ * {@systemProperty javax.rmi.ssl.client.enabledCipherSuites} is
* specified, this method will call {@link
* SSLSocket#setEnabledCipherSuites(String[])} before returning
* the socket. The value of this system property is a string that
@@ -104,7 +104,7 @@
* enable.</p>
*
* <p>If the system property
- * <code>javax.rmi.ssl.client.enabledProtocols</code> is
+ * {@systemProperty javax.rmi.ssl.client.enabledProtocols} is
* specified, this method will call {@link
* SSLSocket#setEnabledProtocols(String[])} before returning the
* socket. The value of this system property is a string that is a