commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang SystemUtils.java
Date Sat, 14 Feb 2004 00:23:50 GMT
ggregory    2004/02/13 16:23:50

  Modified:    lang/src/java/org/apache/commons/lang SystemUtils.java
  Log:
  Javadoc and added some system properties.
  
  Revision  Changes    Path
  1.31      +305 -7    jakarta-commons/lang/src/java/org/apache/commons/lang/SystemUtils.java
  
  Index: SystemUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/SystemUtils.java,v
  retrieving revision 1.30
  retrieving revision 1.31
  diff -u -r1.30 -r1.31
  --- SystemUtils.java	12 Feb 2004 01:58:33 -0000	1.30
  +++ SystemUtils.java	14 Feb 2004 00:23:50 -0000	1.31
  @@ -107,6 +107,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.1
        */
       public static final String AWT_TOOLKIT = getSystemProperty("awt.toolkit");
  @@ -118,8 +124,14 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
  -     * @since Java 1.2.
  +     * @since Java 1.2
        */
       public static final String FILE_ENCODING = getSystemProperty("file.encoding");
   
  @@ -130,17 +142,77 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  -     * @since Java 1.1.
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since Java 1.1
        */
       public static final String FILE_SEPARATOR = getSystemProperty("file.separator");
   
       /**
  +     * <p>The <code>java.awt.fonts</code> System Property.</p>
  +     *
  +     * <p>Defaults to <code>null</code> if the runtime does not have
  +     * security access to read this property or the property does not exist.</p>
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since 2.1
  +     */
  +    public static final String JAVA_AWT_FONTS = getSystemProperty("java.awt.fonts");
  +
  +    /**
  +     * <p>The <code>java.awt.graphicsenv</code> System Property.</p>
  +     *
  +     * <p>Defaults to <code>null</code> if the runtime does not have
  +     * security access to read this property or the property does not exist.</p>
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since 2.1
  +     */
  +    public static final String JAVA_AWT_GRAPHICSENV = getSystemProperty("java.awt.graphicsenv");
  +
  +    /**
  +     * <p>The <code>java.awt.printerjob</code> System Property.</p>
  +     *
  +     * <p>Defaults to <code>null</code> if the runtime does not have
  +     * security access to read this property or the property does not exist.</p>
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since 2.1
  +     */
  +    public static final String JAVA_AWT_PRINTERJOB = getSystemProperty("java.awt.printerjob");
  +
  +    /**
        * <p>The <code>java.class.path</code> System Property. Java class
path.</p>
        *
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  -     * @since Java 1.1.
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since Java 1.1
        */
       public static final String JAVA_CLASS_PATH = getSystemProperty("java.class.path");
   
  @@ -151,7 +223,13 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  -     * @since Java 1.1.
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since Java 1.1
        */
       public static final String JAVA_CLASS_VERSION = getSystemProperty("java.class.version");
   
  @@ -162,6 +240,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2. Not used in Sun versions after 1.2.
        */
       public static final String JAVA_COMPILER = getSystemProperty("java.compiler");
  @@ -173,6 +257,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.4
        */
       public static final String JAVA_ENDORSED_DIRS = getSystemProperty("java.endorsed.dirs");
  @@ -184,6 +274,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.3
        */
       public static final String JAVA_EXT_DIRS = getSystemProperty("java.ext.dirs");
  @@ -194,6 +290,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String JAVA_HOME = getSystemProperty(JAVA_HOME_KEY);
  @@ -204,6 +306,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_IO_TMPDIR = getSystemProperty(JAVA_IO_TMPDIR_KEY);
  @@ -215,6 +323,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_LIBRARY_PATH = getSystemProperty("java.library.path");
  @@ -226,6 +340,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
        * @since Java 1.3
        */
  @@ -238,6 +358,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
        * @since Java 1.3
        */
  @@ -250,6 +376,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_SPECIFICATION_NAME = getSystemProperty("java.specification.name");
  @@ -261,6 +393,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_SPECIFICATION_VENDOR = getSystemProperty("java.specification.vendor");
  @@ -272,16 +410,45 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.3
        */
       public static final String JAVA_SPECIFICATION_VERSION = getSystemProperty("java.specification.version");
   
       /**
  +     * <p>The <code>java.util.prefs.PreferencesFactory</code> System
Property. A class name.</p>
  +     *
  +     * <p>Defaults to <code>null</code> if the runtime does not have
  +     * security access to read this property or the property does not exist.</p>
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since 2.1
  +     * @since Java 1.4
  +     */
  +    public static final String JAVA_UTIL_PREFS_PREFERENCES_FACTORY = getSystemProperty("java.util.prefs.PreferencesFactory");
  +
  +    /**
        * <p>The <code>java.vendor</code> System Property. Java vendor-specific
string.</p>
        *
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String JAVA_VENDOR = getSystemProperty("java.vendor");
  @@ -291,7 +458,13 @@
        *
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
  -      * 
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
       */
       public static final String JAVA_VENDOR_URL = getSystemProperty("java.vendor.url");
  @@ -302,6 +475,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String JAVA_VERSION = getSystemProperty("java.version");
  @@ -313,6 +492,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
        * @since Java 1.2
        */
  @@ -325,6 +510,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_NAME = getSystemProperty("java.vm.name");
  @@ -336,6 +527,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_SPECIFICATION_NAME = getSystemProperty("java.vm.specification.name");
  @@ -347,6 +544,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_SPECIFICATION_VENDOR = getSystemProperty("java.vm.specification.vendor");
  @@ -358,6 +561,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_SPECIFICATION_VERSION = getSystemProperty("java.vm.specification.version");
  @@ -369,6 +578,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_VENDOR = getSystemProperty("java.vm.vendor");
  @@ -380,6 +595,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.2
        */
       public static final String JAVA_VM_VERSION = getSystemProperty("java.vm.version");
  @@ -391,6 +612,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String LINE_SEPARATOR = getSystemProperty("line.separator");
  @@ -401,6 +628,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String OS_ARCH = getSystemProperty("os.arch");
  @@ -411,6 +644,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String OS_NAME = getSystemProperty("os.name");
  @@ -421,6 +660,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String OS_VERSION = getSystemProperty("os.version");
  @@ -432,6 +677,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String PATH_SEPARATOR = getSystemProperty("path.separator");
  @@ -444,6 +695,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
        * @since Java 1.2
        */
  @@ -458,6 +715,12 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String USER_DIR = getSystemProperty(USER_DIR_KEY);
  @@ -468,17 +731,29 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String USER_HOME = getSystemProperty(USER_HOME_KEY);
   
       /**
        * <p>The <code>user.language</code> System Property. User's language
code,
  -     * such as 'en'.</p>
  +     * such as <code>"en"</code>.</p>
        *
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since 2.0
        * @since Java 1.2
        */
  @@ -490,9 +765,32 @@
        * <p>Defaults to <code>null</code> if the runtime does not have
        * security access to read this property or the property does not exist.</p>
        * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
        * @since Java 1.1
        */
       public static final String USER_NAME = getSystemProperty("user.name");
  +
  +    /**
  +     * <p>The <code>user.timezone</code> System Property. 
  +     * For example: <code>"America/Los_Angeles"</code>.</p>
  +     *
  +     * <p>Defaults to <code>null</code> if the runtime does not have
  +     * security access to read this property or the property does not exist.</p>
  +     * 
  +     * <p>
  +     * 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.
  +     * </p>
  +     * 
  +     * @since 2.1
  +     */
  +    public static final String USER_TIMEZONE = getSystemProperty("user.timezone");
   
       // Java version
       //-----------------------------------------------------------------------
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message