diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java index 6984a4678..2b114b620 100644 --- a/src/main/java/org/apache/commons/lang3/SystemUtils.java +++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,16 +22,14 @@ *

* Helpers for {@code java.lang.System}. *

- * *

- * If a system property cannot be read due to security restrictions, the corresponding field in this class will be set to {@code null} - * and a message will be written to {@code System.err}. + * If a system property cannot be read due to security restrictions, the corresponding field in this class will be set + * to {@code null} and a message will be written to {@code System.err}. *

- * *

* #ThreadSafe# *

- * + * * @author Apache Software Foundation * @author Based on code from Avalon Excalibur * @author Based on code from Lucene @@ -85,17 +83,16 @@ public class SystemUtils { *

* On platforms without a GUI, this value is {@code null}. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 */ public static final String AWT_TOOLKIT = getSystemProperty("awt.toolkit"); @@ -107,17 +104,16 @@ public class SystemUtils { *

* File encoding, such as {@code Cp1252}. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.2 */ @@ -127,17 +123,16 @@ public class SystemUtils { *

* The {@code file.separator} System Property. File separator ("/" on UNIX). *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String FILE_SEPARATOR = getSystemProperty("file.separator"); @@ -146,17 +141,16 @@ public class SystemUtils { *

* The {@code java.awt.fonts} System Property. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 */ public static final String JAVA_AWT_FONTS = getSystemProperty("java.awt.fonts"); @@ -165,17 +159,16 @@ public class SystemUtils { *

* The {@code java.awt.graphicsenv} System Property. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 */ public static final String JAVA_AWT_GRAPHICSENV = getSystemProperty("java.awt.graphicsenv"); @@ -185,17 +178,16 @@ public class SystemUtils { * The {@code java.awt.headless} System Property. The value of this property is the String {@code "true"} or * {@code "false"}. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @see #isJavaAwtHeadless() * @since 2.1 * @since Java 1.4 @@ -206,17 +198,16 @@ public class SystemUtils { *

* The {@code java.awt.printerjob} System Property. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 */ public static final String JAVA_AWT_PRINTERJOB = getSystemProperty("java.awt.printerjob"); @@ -225,17 +216,16 @@ public class SystemUtils { *

* The {@code java.class.path} System Property. Java class path. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_CLASS_PATH = getSystemProperty("java.class.path"); @@ -244,37 +234,35 @@ public class SystemUtils { *

* The {@code java.class.version} System Property. Java class format version number. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_CLASS_VERSION = getSystemProperty("java.class.version"); /** *

- * The {@code java.compiler} System Property. Name of JIT compiler to use. First in JDK version 1.2. Not used in Sun JDKs after - * 1.2. + * The {@code java.compiler} System Property. Name of JIT compiler to use. First in JDK version 1.2. Not used in Sun + * JDKs after 1.2. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2. Not used in Sun versions after 1.2. */ public static final String JAVA_COMPILER = getSystemProperty("java.compiler"); @@ -283,17 +271,16 @@ public class SystemUtils { *

* The {@code java.endorsed.dirs} System Property. Path of endorsed directory or directories. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.4 */ public static final String JAVA_ENDORSED_DIRS = getSystemProperty("java.endorsed.dirs"); @@ -302,17 +289,16 @@ public class SystemUtils { *

* The {@code java.ext.dirs} System Property. Path of extension directory or directories. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.3 */ public static final String JAVA_EXT_DIRS = getSystemProperty("java.ext.dirs"); @@ -321,17 +307,16 @@ public class SystemUtils { *

* The {@code java.home} System Property. Java installation directory. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_HOME = getSystemProperty(JAVA_HOME_KEY); @@ -340,17 +325,16 @@ public class SystemUtils { *

* The {@code java.io.tmpdir} System Property. Default temp file path. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_IO_TMPDIR = getSystemProperty(JAVA_IO_TMPDIR_KEY); @@ -359,17 +343,16 @@ public class SystemUtils { *

* The {@code java.library.path} System Property. List of paths to search when loading libraries. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_LIBRARY_PATH = getSystemProperty("java.library.path"); @@ -378,17 +361,16 @@ public class SystemUtils { *

* The {@code java.runtime.name} System Property. Java Runtime Environment name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.3 */ @@ -398,17 +380,16 @@ public class SystemUtils { *

* The {@code java.runtime.version} System Property. Java Runtime Environment version. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.3 */ @@ -418,17 +399,16 @@ public class SystemUtils { *

* The {@code java.specification.name} System Property. Java Runtime Environment specification name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_SPECIFICATION_NAME = getSystemProperty("java.specification.name"); @@ -437,17 +417,16 @@ public class SystemUtils { *

* The {@code java.specification.vendor} System Property. Java Runtime Environment specification vendor. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_SPECIFICATION_VENDOR = getSystemProperty("java.specification.vendor"); @@ -456,17 +435,16 @@ public class SystemUtils { *

* The {@code java.specification.version} System Property. Java Runtime Environment specification version. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.3 */ public static final String JAVA_SPECIFICATION_VERSION = getSystemProperty("java.specification.version"); @@ -476,37 +454,36 @@ public class SystemUtils { *

* The {@code java.util.prefs.PreferencesFactory} System Property. A class name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 * @since Java 1.4 */ - public static final String JAVA_UTIL_PREFS_PREFERENCES_FACTORY = getSystemProperty("java.util.prefs.PreferencesFactory"); + public static final String JAVA_UTIL_PREFS_PREFERENCES_FACTORY = + getSystemProperty("java.util.prefs.PreferencesFactory"); /** *

* The {@code java.vendor} System Property. Java vendor-specific string. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_VENDOR = getSystemProperty("java.vendor"); @@ -515,17 +492,16 @@ public class SystemUtils { *

* The {@code java.vendor.url} System Property. Java vendor URL. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_VENDOR_URL = getSystemProperty("java.vendor.url"); @@ -534,17 +510,16 @@ public class SystemUtils { *

* The {@code java.version} System Property. Java version number. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String JAVA_VERSION = getSystemProperty("java.version"); @@ -553,17 +528,16 @@ public class SystemUtils { *

* The {@code java.vm.info} System Property. Java Virtual Machine implementation info. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.2 */ @@ -573,17 +547,16 @@ public class SystemUtils { *

* The {@code java.vm.name} System Property. Java Virtual Machine implementation name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_NAME = getSystemProperty("java.vm.name"); @@ -592,17 +565,16 @@ public class SystemUtils { *

* The {@code java.vm.specification.name} System Property. Java Virtual Machine specification name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_NAME = getSystemProperty("java.vm.specification.name"); @@ -611,17 +583,16 @@ public class SystemUtils { *

* The {@code java.vm.specification.vendor} System Property. Java Virtual Machine specification vendor. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_VENDOR = getSystemProperty("java.vm.specification.vendor"); @@ -630,17 +601,16 @@ public class SystemUtils { *

* The {@code java.vm.specification.version} System Property. Java Virtual Machine specification version. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_VERSION = getSystemProperty("java.vm.specification.version"); @@ -649,17 +619,16 @@ public class SystemUtils { *

* The {@code java.vm.vendor} System Property. Java Virtual Machine implementation vendor. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_VENDOR = getSystemProperty("java.vm.vendor"); @@ -668,17 +637,16 @@ public class SystemUtils { *

* The {@code java.vm.version} System Property. Java Virtual Machine implementation version. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.2 */ public static final String JAVA_VM_VERSION = getSystemProperty("java.vm.version"); @@ -687,17 +655,16 @@ public class SystemUtils { *

* The {@code line.separator} System Property. Line separator ("\n" on UNIX). *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String LINE_SEPARATOR = getSystemProperty("line.separator"); @@ -706,17 +673,16 @@ public class SystemUtils { *

* The {@code os.arch} System Property. Operating system architecture. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String OS_ARCH = getSystemProperty("os.arch"); @@ -725,17 +691,16 @@ public class SystemUtils { *

* The {@code os.name} System Property. Operating system name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String OS_NAME = getSystemProperty("os.name"); @@ -744,17 +709,16 @@ public class SystemUtils { *

* The {@code os.version} System Property. Operating system version. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String OS_VERSION = getSystemProperty("os.version"); @@ -763,58 +727,55 @@ public class SystemUtils { *

* The {@code path.separator} System Property. Path separator (":" on UNIX). *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String PATH_SEPARATOR = getSystemProperty("path.separator"); /** *

- * The {@code user.country} or {@code user.region} System Property. User's country code, such as {@code GB}. First in - * Java version 1.2 as {@code user.region}. Renamed to {@code user.country} in 1.4 + * The {@code user.country} or {@code user.region} System Property. User's country code, such as {@code GB}. First + * in Java version 1.2 as {@code user.region}. Renamed to {@code user.country} in 1.4 *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.2 */ - public static final String USER_COUNTRY = getSystemProperty("user.country") == null ? getSystemProperty("user.region") - : getSystemProperty("user.country"); + public static final String USER_COUNTRY = getSystemProperty("user.country") == null ? + getSystemProperty("user.region") : getSystemProperty("user.country"); /** *

* The {@code user.dir} System Property. User's current working directory. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String USER_DIR = getSystemProperty(USER_DIR_KEY); @@ -823,17 +784,16 @@ public class SystemUtils { *

* The {@code user.home} System Property. User's home directory. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String USER_HOME = getSystemProperty(USER_HOME_KEY); @@ -842,17 +802,16 @@ public class SystemUtils { *

* The {@code user.language} System Property. User's language code, such as {@code "en"}. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.0 * @since Java 1.2 */ @@ -862,17 +821,16 @@ public class SystemUtils { *

* The {@code user.name} System Property. User's account name. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since Java 1.1 */ public static final String USER_NAME = getSystemProperty("user.name"); @@ -881,17 +839,16 @@ public class SystemUtils { *

* The {@code user.timezone} System Property. For example: {@code "America/Los_Angeles"}. *

- * *

- * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist. + * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. *

- * *

* This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or - * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of sync with that - * System property. + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. *

- * + * * @since 2.1 */ public static final String USER_TIMEZONE = getSystemProperty("user.timezone"); @@ -905,7 +862,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.1 (also 1.1.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -916,7 +872,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.2 (also 1.2.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -927,7 +882,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.3 (also 1.3.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -938,7 +892,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.4 (also 1.4.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -949,7 +902,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.5 (also 1.5.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -960,7 +912,6 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.6 (also 1.6.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

@@ -971,11 +922,10 @@ public class SystemUtils { *

* Is {@code true} if this is Java version 1.7 (also 1.7.x versions). *

- * *

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

- * + * * @since 3.0 */ public static final boolean IS_JAVA_1_7 = getJavaVersionMatches("1.7"); @@ -992,11 +942,10 @@ public class SystemUtils { *

* Is {@code true} if this is AIX. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_AIX = getOSMatchesName("AIX"); @@ -1005,11 +954,10 @@ public class SystemUtils { *

* Is {@code true} if this is HP-UX. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_HP_UX = getOSMatchesName("HP-UX"); @@ -1018,11 +966,10 @@ public class SystemUtils { *

* Is {@code true} if this is Irix. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_IRIX = getOSMatchesName("Irix"); @@ -1031,11 +978,10 @@ public class SystemUtils { *

* Is {@code true} if this is Linux. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_LINUX = getOSMatchesName("Linux") || getOSMatchesName("LINUX"); @@ -1044,11 +990,10 @@ public class SystemUtils { *

* Is {@code true} if this is Mac. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_MAC = getOSMatchesName("Mac"); @@ -1057,11 +1002,10 @@ public class SystemUtils { *

* Is {@code true} if this is Mac. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_MAC_OSX = getOSMatchesName("Mac OS X"); @@ -1070,11 +1014,10 @@ public class SystemUtils { *

* Is {@code true} if this is OS/2. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_OS2 = getOSMatchesName("OS/2"); @@ -1083,11 +1026,10 @@ public class SystemUtils { *

* Is {@code true} if this is Solaris. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_SOLARIS = getOSMatchesName("Solaris"); @@ -1096,11 +1038,10 @@ public class SystemUtils { *

* Is {@code true} if this is SunOS. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_SUN_OS = getOSMatchesName("SunOS"); @@ -1109,25 +1050,23 @@ public class SystemUtils { *

* Is {@code true} if this is a UNIX like system, as in any of AIX, HP-UX, Irix, Linux, MacOSX, Solaris or SUN OS. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.1 */ - public static final boolean IS_OS_UNIX = IS_OS_AIX || IS_OS_HP_UX || IS_OS_IRIX || IS_OS_LINUX || IS_OS_MAC_OSX || IS_OS_SOLARIS - || IS_OS_SUN_OS; + public static final boolean IS_OS_UNIX = IS_OS_AIX || IS_OS_HP_UX || IS_OS_IRIX || IS_OS_LINUX || IS_OS_MAC_OSX + || IS_OS_SOLARIS || IS_OS_SUN_OS; /** *

* Is {@code true} if this is Windows. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS = getOSMatchesName(OS_NAME_WINDOWS_PREFIX); @@ -1136,11 +1075,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows 2000. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_2000 = getOSMatches(OS_NAME_WINDOWS_PREFIX, "5.0"); @@ -1149,11 +1087,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows 95. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_95 = getOSMatches(OS_NAME_WINDOWS_PREFIX + " 9", "4.0"); @@ -1163,11 +1100,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows 98. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_98 = getOSMatches(OS_NAME_WINDOWS_PREFIX + " 9", "4.1"); @@ -1177,11 +1113,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows ME. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_ME = getOSMatches(OS_NAME_WINDOWS_PREFIX, "4.9"); @@ -1191,11 +1126,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows NT. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_NT = getOSMatchesName(OS_NAME_WINDOWS_PREFIX + " NT"); @@ -1205,11 +1139,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows XP. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.0 */ public static final boolean IS_OS_WINDOWS_XP = getOSMatches(OS_NAME_WINDOWS_PREFIX, "5.1"); @@ -1219,11 +1152,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows Vista. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 2.4 */ public static final boolean IS_OS_WINDOWS_VISTA = getOSMatches(OS_NAME_WINDOWS_PREFIX, "6.0"); @@ -1232,11 +1164,10 @@ public class SystemUtils { *

* Is {@code true} if this is Windows 7. *

- * *

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

- * + * * @since 3.0 */ public static final boolean IS_OS_WINDOWS_7 = getOSMatches(OS_NAME_WINDOWS_PREFIX, "6.1"); @@ -1245,11 +1176,10 @@ public class SystemUtils { *

* Gets the Java home directory as a {@code File}. *

- * + * * @return a directory - * @throws SecurityException - * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system - * property. + * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow + * access to the specified system property. * @see System#getProperty(String) * @since 2.1 */ @@ -1261,11 +1191,10 @@ public static File getJavaHome() { *

* Gets the Java IO temporary directory as a {@code File}. *

- * + * * @return a directory - * @throws SecurityException - * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system - * property. + * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow + * access to the specified system property. * @see System#getProperty(String) * @since 2.1 */ @@ -1277,9 +1206,8 @@ public static File getJavaIoTmpDir() { *

* Decides if the Java version matches. *

- * - * @param versionPrefix - * the prefix for the java version + * + * @param versionPrefix the prefix for the java version * @return true if matches, or false if not or can't determine */ private static boolean getJavaVersionMatches(String versionPrefix) { @@ -1288,11 +1216,9 @@ private static boolean getJavaVersionMatches(String versionPrefix) { /** * Decides if the operating system matches. - * - * @param osNamePrefix - * the prefix for the os name - * @param osVersionPrefix - * the prefix for the version + * + * @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(String osNamePrefix, String osVersionPrefix) { @@ -1301,9 +1227,8 @@ private static boolean getOSMatches(String osNamePrefix, String osVersionPrefix) /** * Decides if the operating system matches. - * - * @param osNamePrefix - * the prefix for the os name + * + * @param osNamePrefix the prefix for the os name * @return true if matches, or false if not or can't determine */ private static boolean getOSMatchesName(String osNamePrefix) { @@ -1315,14 +1240,12 @@ private static boolean getOSMatchesName(String osNamePrefix) { *

* Gets a System property, defaulting to {@code null} if the property cannot be read. *

- * *

* If a {@code SecurityException} is caught, the return value is {@code null} and a message is written to * {@code System.err}. *

- * - * @param property - * the system property name + * + * @param property the system property name * @return the system property value or {@code null} if a security problem occurs */ private static String getSystemProperty(String property) { @@ -1340,11 +1263,10 @@ private static String getSystemProperty(String property) { *

* Gets the user directory as a {@code File}. *

- * + * * @return a directory - * @throws SecurityException - * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system - * property. + * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow + * access to the specified system property. * @see System#getProperty(String) * @since 2.1 */ @@ -1356,11 +1278,10 @@ public static File getUserDir() { *

* Gets the user home directory as a {@code File}. *

- * + * * @return a directory - * @throws SecurityException - * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system - * property. + * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow + * access to the specified system property. * @see System#getProperty(String) * @since 2.1 */ @@ -1370,9 +1291,8 @@ public static File getUserHome() { /** * Returns whether the {@link #JAVA_AWT_HEADLESS} value is {@code true}. - * + * * @return {@code true} if {@code JAVA_AWT_HEADLESS} is {@code "true"}, {@code false} otherwise. - * * @see #JAVA_AWT_HEADLESS * @since 2.1 * @since Java 1.4 @@ -1385,7 +1305,6 @@ public static boolean isJavaAwtHeadless() { *

* Is the Java version at least the requested version. *

- * *

* Example input: *

@@ -1393,9 +1312,8 @@ public static boolean isJavaAwtHeadless() { *
  • {@code 1.2f} to test for Java 1.2
    • *
  • {@code 1.31f} to test for Java 1.3.1
    • * - * - * @param requiredVersion - * the required version, for example 1.31f + * + * @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(JavaVersion requiredVersion) { @@ -1409,11 +1327,9 @@ public static boolean isJavaVersionAtLeast(JavaVersion requiredVersion) { *

    * This method is package private instead of private to support unit test invocation. *

    - * - * @param version - * the actual Java version - * @param versionPrefix - * the prefix for the expected Java version + * + * @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(String version, String versionPrefix) { @@ -1428,15 +1344,11 @@ static boolean isJavaVersionMatch(String version, String versionPrefix) { *

    * This method is package private instead of private to support unit test invocation. *

    - * - * @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 + * + * @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(String osName, String osVersion, String osNamePrefix, String osVersionPrefix) { @@ -1451,11 +1363,9 @@ static boolean isOSMatch(String osName, String osVersion, String osNamePrefix, S *

    * This method is package private instead of private to support unit test invocation. *

    - * - * @param osName - * the actual OS name - * @param osNamePrefix - * the prefix for the expected OS name + * + * @param osName the actual OS name + * @param osNamePrefix the prefix for the expected OS name * @return true if matches, or false if not or can't determine */ static boolean isOSNameMatch(String osName, String osNamePrefix) { @@ -1471,7 +1381,6 @@ static boolean isOSNameMatch(String osName, String osNamePrefix) { * SystemUtils instances should NOT be constructed in standard programming. Instead, the class should be used as * {@code SystemUtils.FILE_SEPARATOR}. *

    - * *

    * This constructor is public to permit tools that require a JavaBean instance to operate. *