Javadoc

Author: garydgregory

src/main/java/org/apache/commons/lang3/SystemUtils.java

@@ -2037,9 +2037,9 @@ public class SystemUtils {
      * If a {@link SecurityException} is caught, the return value is {@code defaultValue} and a message is written to {@code System.err}.
      * </p>
      *
-     * @param name         the environment variable name
-     * @param defaultValue the default value
-     * @return the environment variable value or {@code defaultValue} if a security problem occurs
+     * @param name         the environment variable name.
+     * @param defaultValue the default value.
+     * @return the environment variable value or {@code defaultValue} if a security problem occurs.
      * @since 3.8
      */
     public static String getEnvironmentVariable(final String name, final String defaultValue) {
@@ -2070,7 +2070,7 @@ public static String getHostName() {
     /**
      * Gets the current Java home directory as a {@link File}.
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getJavaHome()
      * @since 2.1
@@ -2082,7 +2082,7 @@ public static File getJavaHome() {
     /**
      * Gets the current Java home directory as a {@link File}.
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getJavaHome()
      * @since 3.18.0
@@ -2094,7 +2094,7 @@ public static Path getJavaHomePath() {
     /**
      * Gets the current Java IO temporary directory as a {@link File}.
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getJavaIoTmpdir()
      * @since 2.1
@@ -2106,7 +2106,7 @@ public static File getJavaIoTmpDir() {
     /**
      * Gets the current Java IO temporary directory as a {@link Path}.
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getJavaIoTmpdir()
      * @since 3.18.0
@@ -2121,8 +2121,8 @@ public static Path getJavaIoTmpDirPath() {
      * The result depends on the value of the {@link #JAVA_SPECIFICATION_VERSION} constant.
      * </p>
      *
-     * @param versionPrefix the prefix for the Java version
-     * @return true if matches, or false if not or can't determine
+     * @param versionPrefix the prefix for the Java version.
+     * @return true if matches, or false if not or can't determine.
      */
     private static boolean getJavaVersionMatches(final String versionPrefix) {
         return isJavaVersionMatch(JAVA_SPECIFICATION_VERSION, versionPrefix);
@@ -2137,9 +2137,9 @@ private static boolean getJavaVersionMatches(final String versionPrefix) {
      * The method returns {@code false} if {@link #OS_NAME} or {@link #OS_VERSION} is {@code null}.
      * </p>
      *
-     * @param osNamePrefix    the prefix for the OS name
-     * @param osVersionPrefix the prefix for the version
-     * @return true if matches, or false if not or can't determine
+     * @param osNamePrefix    the prefix for the OS name.
+     * @param osVersionPrefix the prefix for the version.
+     * @return true if matches, or false if not or can't determine.
      */
     private static boolean getOsMatches(final String osNamePrefix, final String osVersionPrefix) {
         return isOsMatch(OS_NAME, OS_VERSION, osNamePrefix, osVersionPrefix);
@@ -2154,8 +2154,8 @@ private static boolean getOsMatches(final String osNamePrefix, final String osVe
      * The method returns {@code false} if {@link #OS_NAME} is {@code null}.
      * </p>
      *
-     * @param osNamePrefix the prefix for the OS name
-     * @return true if matches, or false if not or can't determine
+     * @param osNamePrefix the prefix for the OS name.
+     * @return true if matches, or false if not or can't determine.
      */
     private static boolean getOsNameMatches(final String osNamePrefix) {
         return isOsNameMatch(OS_NAME, osNamePrefix);
@@ -2167,7 +2167,7 @@ private static boolean getOsNameMatches(final String osNamePrefix) {
      * The result is based on the system property {@value SystemProperties#USER_DIR}.
      * </p>
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserDir()
      * @since 2.1
@@ -2182,7 +2182,7 @@ public static File getUserDir() {
      * The result is based on the system property {@value SystemProperties#USER_DIR}.
      * </p>
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserDir()
      * @since 3.18.0
@@ -2197,7 +2197,7 @@ public static Path getUserDirPath() {
      * The result is based on the system property {@value SystemProperties#USER_HOME}.
      * </p>
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserHome()
      * @since 2.1
@@ -2212,7 +2212,7 @@ public static File getUserHome() {
      * The result is based on the system property {@value SystemProperties#USER_HOME}.
      * </p>
      *
-     * @return a directory
+     * @return a directory.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserHome()
      * @since 3.18.0
@@ -2227,7 +2227,7 @@ public static Path getUserHomePath() {
      * The result is based on the system property {@value SystemProperties#USER_NAME}.
      * </p>
      *
-     * @return a name
+     * @return a name.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserName()
      * @since 3.10
@@ -2245,7 +2245,7 @@ public static String getUserName() {
      * </p>
      *
      * @param defaultValue A default value.
-     * @return a name
+     * @return a name.
      * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system property.
      * @see SystemProperties#getUserName()
      * @since 3.10
@@ -2277,8 +2277,8 @@ public static boolean isJavaAwtHeadless() {
      * The result is based on the system property saved in {@link #JAVA_SPECIFICATION_VERSION}.
      * </p>
      *
-     * @param requiredVersion the required version, for example 1.31f
-     * @return {@code true} if the actual version is equal or greater than the required version
+     * @param requiredVersion the required version, for example 1.31f.
+     * @return {@code true} if the actual version is equal or greater than the required version.
      */
     public static boolean isJavaVersionAtLeast(final JavaVersion requiredVersion) {
         return JAVA_SPECIFICATION_VERSION_AS_ENUM != null && JAVA_SPECIFICATION_VERSION_AS_ENUM.atLeast(requiredVersion);
@@ -2290,8 +2290,8 @@ public static boolean isJavaVersionAtLeast(final JavaVersion requiredVersion) {
      * The result is based on the system property saved in {@link #JAVA_SPECIFICATION_VERSION}.
      * </p>
      *
-     * @param requiredVersion the required version, for example 1.31f
-     * @return {@code true} if the actual version is equal or less than the required version
+     * @param requiredVersion the required version, for example 1.31f.
+     * @return {@code true} if the actual version is equal or less than the required version.
      * @since 3.9
      */
     public static boolean isJavaVersionAtMost(final JavaVersion requiredVersion) {
@@ -2305,9 +2305,9 @@ public static boolean isJavaVersionAtMost(final JavaVersion requiredVersion) {
      * This method is package private instead of private to support unit test invocation.
      * </p>
      *
-     * @param version       the actual Java version
-     * @param versionPrefix the prefix for the expected Java version
-     * @return true if matches, or false if not or can't determine
+     * @param version       the actual Java version.
+     * @param versionPrefix the prefix for the expected Java version.
+     * @return true if matches, or false if not or can't determine.
      */
     static boolean isJavaVersionMatch(final String version, final String versionPrefix) {
         if (version == null) {
@@ -2322,11 +2322,11 @@ static boolean isJavaVersionMatch(final String version, final String versionPref
      * This method is package private instead of private to support unit test invocation.
      * </p>
      *
-     * @param osName          the actual OS name
-     * @param osVersion       the actual OS version
-     * @param osNamePrefix    the prefix for the expected OS name
-     * @param osVersionPrefix the prefix for the expected OS version
-     * @return true if matches, or false if not or can't determine
+     * @param osName          the actual OS name.
+     * @param osVersion       the actual OS version.
+     * @param osNamePrefix    the prefix for the expected OS name.
+     * @param osVersionPrefix the prefix for the expected OS version.
+     * @return true if matches, or false if not or can't determine.
      */
     static boolean isOsMatch(final String osName, final String osVersion, final String osNamePrefix, final String osVersionPrefix) {
         if (osName == null || osVersion == null) {
@@ -2358,9 +2358,9 @@ static boolean isOsNameMatch(final String osName, final String osNamePrefix) {
      * This method is package private instead of private to support unit test invocation.
      * </p>
      *
-     * @param osVersion       the actual OS version
-     * @param osVersionPrefix the prefix for the expected OS version
-     * @return true if matches, or false if not or can't determine
+     * @param osVersion       the actual OS version.
+     * @param osVersionPrefix the prefix for the expected OS version.
+     * @return true if matches, or false if not or can't determine.
      */
     static boolean isOsVersionMatch(final String osVersion, final String osVersionPrefix) {
         if (StringUtils.isEmpty(osVersion)) {