GlobalProperties

java.lang.Object
- net.algart.lib.GlobalProperties

```
public final class GlobalProperties
extends java.lang.Object
```
This class offers a global store for different string properties. If some class MyClass needs a global flag or control parameter that acts on the class behaviour, we offer to use the following idiom:
```
    public static final MY_CONTROL_PARAMETER = GlobalProperties.getClassProperty(
      MyClass.class,
      "MY_CONTROL_PARAMETER",
      (default value));
 
```
(or analogous). Then the behaviour of your class, controlled by this parameter, will be guaranteed unchanged since the moment of the class initialization. Simultaneously, you are able to initialize this control parameter in your application or applet before the first access to that class by GlobalProperties.setProperty(String, String) method.
GlobalProperties class does not depend, directly or indirectly, on any other classes excepting standard Java API.
Unlike System.getProperty call, the methods of this class never throw SecurityException. It makes GlobalProperties class more suitable for creating service Java libraries.
By default, the global store supported by GlobalProperties contains the following 3 properties:
- "line.separator" (also stored in LINE_SEPARATOR class constant),
- "file.separator" (also stored in FILE_SEPARATOR class constant),
- "path.separator" (also stored in PATH_SEPARATOR class constant).
These values are calculated while initializing GlobalProperties on the base of standard Java Runtime libraries, without any risk to meet with SecurityException.
For Java applications, initializing GlobalProperties by standard system properties can be a good idea:
```
    GlobalProperties.setProperties(System.getProperties());
 
```
(In applets, System.getProperties() throws SecurityException usually.)
Since:

JDK1.0

Version:

1.0

Author:

Daniel Alievsky

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`FILE_SEPARATOR` Equivalent of the standard `File.separatorChar` constant: the system-dependent default name-separator character.
`static java.lang.String`	`JAVA_NATIVE_ENABLED_PROPERTY_NAME` The name of the global boolean property that is recommended to be used for "disabling native code", i.e.
`static java.lang.String`	`LINE_SEPARATOR` The standard sequence of characters that separates lines in text files and console output.
`static char`	`PATH_SEPARATOR` Equivalent of the standard `File.pathSeparatorChar` constant: the system-dependent path-separator character.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`fix()` Fixes the global store: any modifications become impossible after the first call of this method.
`static java.lang.Boolean`	`getBooleanProperty(java.lang.String key)` Returns the global boolean property with the given name `key`.
`static boolean`	`getBooleanProperty(java.lang.String key, boolean defaultValue)` Returns the global boolean property with the given name `key`.
`static java.lang.Boolean`	`getClassBooleanProperty(java.lang.Class clazz, java.lang.String key)` Equivalent to `getBooleanProperty(getClassPropertyName(clazz,key))` call.
`static boolean`	`getClassBooleanProperty(java.lang.Class clazz, java.lang.String key, boolean defaultValue)` Equivalent to `getBooleanProperty(getClassPropertyName(clazz,key),defaultValue)` call.
`static int`	`getClassDebugLevel(java.lang.Class clazz)` Equivalent to `getClassIntProperty(clazz, "DEBUG_LEVEL", 0)`.
`static java.lang.Integer`	`getClassIntProperty(java.lang.Class clazz, java.lang.String key)` Equivalent to `getIntProperty(getClassPropertyName(clazz,key))` call.
`static int`	`getClassIntProperty(java.lang.Class clazz, java.lang.String key, int defaultValue)` Equivalent to `getIntProperty(getClassPropertyName(clazz,key),defaultValue)` call.
`static java.lang.Long`	`getClassLongProperty(java.lang.Class clazz, java.lang.String key)` Equivalent to `getLongProperty(getClassPropertyName(clazz,key))` call.
`static long`	`getClassLongProperty(java.lang.Class clazz, java.lang.String key, long defaultValue)` Equivalent to `getLongProperty(getClassPropertyName(clazz,key),defaultValue)` call.
`static java.lang.String`	`getClassProperty(java.lang.Class clazz, java.lang.String key)` Equivalent to `getProperty(getClassPropertyName(clazz,key))` call.
`static java.lang.String`	`getClassProperty(java.lang.Class clazz, java.lang.String key, java.lang.String defaultValue)` Equivalent to `getProperty(getClassPropertyName(clazz,key),defaultValue)` call.
`static java.lang.String`	`getClassPropertyName(java.lang.Class clazz, java.lang.String key)` Returns the name for a property oriented to the given class.
`static java.lang.Integer`	`getIntProperty(java.lang.String key)` Returns the global integer property with the given name `key`.
`static int`	`getIntProperty(java.lang.String key, int defaultValue)` Returns the global integer property with the given name `key`.
`static java.lang.Long`	`getLongProperty(java.lang.String key)` Returns the global long integer property with the given name `key`.
`static long`	`getLongProperty(java.lang.String key, long defaultValue)` Returns the global long integer property with the given name `key`.
`static java.util.Properties`	`getProperties()` Returns all properties stored in the global store represented by `GlobalProperties` class.
`static java.lang.String`	`getProperty(java.lang.String key)` Returns the global property with the given name `key`.
`static java.lang.String`	`getProperty(java.lang.String key, java.lang.String defaultValue)` Returns the global property with the given name `key`, or `defaultValue` if there is no such a property.
`static java.lang.String`	`removeProperty(java.lang.String key)` Removes the global property with the given name `key`.
`static void`	`setBooleanProperty(java.lang.String key, boolean value)` Equivalent to `setProperty(key, String.valueOf(value))` call.
`static void`	`setIntProperty(java.lang.String key, int value)` Equivalent to `setProperty(key, String.valueOf(value))` call.
`static void`	`setLongProperty(java.lang.String key, long value)` Equivalent to `setProperty(key, String.valueOf(value))` call.
`static void`	`setProperties(java.util.Properties properties)` Adds a collection of string properties to the global store.
`static java.lang.String`	`setProperty(java.lang.String key, java.lang.String value)` Sets the global string property with the given name `key`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LINE_SEPARATOR
```
public static final java.lang.String LINE_SEPARATOR
```
    The standard sequence of characters that separates lines in text files and console output. Depends on operating system: "\n" on Unix-like systems, "\r\n" on DOS/Windows family, "\r" on Macintosh.
    Standard System.out.println() call is equivalent to System.out.print(LINE_SEPARATOR).
    If you want to print several lines on the console by a single call of System.out.println, you must always use LINE_SEPARATOR to separate lines instead more simple "\n". For example, the call
```
    System.out.println("First line\nSecond line");
 
```
    is incorrect (unlike an analogous call in C/C++): it will not properly work under Macintosh. The following call should be called instead:
```
    System.out.println("First line" + GlobalProperties.LINE_SEPARATOR + "Second line");
 
```
    You can also use the following more simple call that is also correct:
```
    Out.println("First line\nSecond line")
 
```
    LINE_SEPARATOR is also recommended to be used while creating text files that should be then used by other software installed on the same operating system.
    See Also:
    Out.print(String), Out.println(String)
  - FILE_SEPARATOR
```
public static final char FILE_SEPARATOR
```
    Equivalent of the standard File.separatorChar constant: the system-dependent default name-separator character. On UNIX systems the value of this constant is '/'; on Microsoft Windows systems it is '\'.
  - PATH_SEPARATOR
```
public static final char PATH_SEPARATOR
```
    Equivalent of the standard File.pathSeparatorChar constant: the system-dependent path-separator character. This character is used to separate filenames in a sequence of files given as a path list. On UNIX systems, this character is ':'; on Microsoft Windows systems it is ';'.
  - JAVA_NATIVE_ENABLED_PROPERTY_NAME
```
public static final java.lang.String JAVA_NATIVE_ENABLED_PROPERTY_NAME
```
    The name of the global boolean property that is recommended to be used for "disabling native code", i.e. for informing classes, which may need native libraries, that they should not try to call loadLibrary or load methods of System and Runtime standard classes.
    More precisely, all classes in net.algart.* package, which use native-code for optimization or other goals, never try to load external native libraries if
```
    GlobalProperties.getBooleanProperty(
      GlobalProperties.JAVA_NATIVE_ENABLED_PROPERTY_NAME,
      true)
 
```
    returns false. If other case, and if some exceptions occur while attempt to call System.load(...), these classes don't use native methods and work using only methods implemented in Java. If you implements your own class, which need native code but can be implemented without native also, we recommend you to follow the same logic.
    In Java applications, you usually don't need to set this property.
    In Java applets, we recommend to disable native libraries by the call
```
    GlobalProperties.setBooleanProperty(JAVA_NATIVE_ENABLED_PROPERTY_NAME,false)
 
```
    before the first access to any other classes excepting standard Java API classes. Without such a call, Microsoft Internet Explorer with Microsoft JVM will print an error message while initializing classes that try to load native library, despite catching and ignoring all possible exceptions while such an attempt.
    See Also:
    Constant Field Values
- Method Detail
  - getProperties
```
public static java.util.Properties getProperties()
```
    Returns all properties stored in the global store represented by GlobalProperties class. The returned object is a clone of the internal store. All keys and values in the returned java.util.Properties object are instances of String class.
    
    Returns:
    all properties stored in the global store
    See Also:
    getProperty(String), getProperty(String, String)
  - getProperty
```
public static java.lang.String getProperty(java.lang.String key)
```
    Returns the global property with the given name key.
    Returns null if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the property with the given name
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String), getBooleanProperty(String), getIntProperty(String), getLongProperty(String), getClassProperty(Class, String), setProperty(String, String)
  - getProperty
```
public static java.lang.String getProperty(java.lang.String key,
                           java.lang.String defaultValue)
```
    Returns the global property with the given name key, or defaultValue if there is no such a property.
    
    Parameters:
    key - the property name
    defaultValue - the default value for this property
    
    Returns:
    the property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String), getBooleanProperty(String, boolean), getIntProperty(String, int), getLongProperty(String, long), getClassProperty(Class, String, String), setProperty(String, String)
  - getBooleanProperty
```
public static java.lang.Boolean getBooleanProperty(java.lang.String key)
```
    Returns the global boolean property with the given name key. It is calculated as a result of Boolean.valueOf(value) call, where value is a result of getProperty(key) call.
    Returns null if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the Boolean wrapper for an existing boolean property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getBooleanProperty
```
public static boolean getBooleanProperty(java.lang.String key,
                         boolean defaultValue)
```
    Returns the global boolean property with the given name key. It is calculated as a result of Boolean.valueOf(value).booleanValue() call, where value is a result of getProperty(key) call.
    Returns defaultValue if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the boolean property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getIntProperty
```
public static java.lang.Integer getIntProperty(java.lang.String key)
```
    Returns the global integer property with the given name key. It is calculated as a result of Integer.valueOf(value) call, where value is a result of getProperty(key) call.
    Returns null if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the Integer wrapper for an existing integer property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getIntProperty
```
public static int getIntProperty(java.lang.String key,
                 int defaultValue)
```
    Returns the global integer property with the given name key. It is calculated as a result of Integer.valueOf(value).intValue() call, where value is a result of getProperty(key) call.
    Returns defaultValue if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the integer property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getLongProperty
```
public static java.lang.Long getLongProperty(java.lang.String key)
```
    Returns the global long integer property with the given name key. It is calculated as a result of Long.valueOf(value) call, where value is a result of getProperty(key) call.
    Returns null if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the Long wrapper for an existing long integer property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getLongProperty
```
public static long getLongProperty(java.lang.String key,
                   long defaultValue)
```
    Returns the global long integer property with the given name key. It is calculated as a result of Long.valueOf(value).longValue() call, where value is a result of getProperty(key) call.
    Returns defaultValue if there is no property with the given name.
    
    Parameters:
    key - the property name
    
    Returns:
    the long integer property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    getProperty(String, String)
  - getClassPropertyName
```
public static java.lang.String getClassPropertyName(java.lang.Class clazz,
                                    java.lang.String key)
```
    Returns the name for a property oriented to the given class. Such property names are used by the methods GlobalProperties.getClassProperty and GlobalProperties.getClassXxxProperty.
    
    Parameters:
    clazz - the given class
    key - the property name inside the class
    
    Returns:
    clazz.getName() + "." + key
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
  - getClassProperty
```
public static java.lang.String getClassProperty(java.lang.Class clazz,
                                java.lang.String key)
```
    Equivalent to getProperty(getClassPropertyName(clazz,key)) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    
    Returns:
    the property with the given name, or null for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getProperty(String), getClassBooleanProperty(Class, String), getClassIntProperty(Class, String), getClassLongProperty(Class, String), getClassProperty(Class, String, String)
  - getClassProperty
```
public static java.lang.String getClassProperty(java.lang.Class clazz,
                                java.lang.String key,
                                java.lang.String defaultValue)
```
    Equivalent to getProperty(getClassPropertyName(clazz,key),defaultValue) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    defaultValue - the default value for this property
    
    Returns:
    the property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getProperty(String, String), getClassBooleanProperty(Class, String, boolean), getClassIntProperty(Class, String, int), getClassLongProperty(Class, String, long), getClassProperty(Class, String)
  - getClassBooleanProperty
```
public static java.lang.Boolean getClassBooleanProperty(java.lang.Class clazz,
                                        java.lang.String key)
```
    Equivalent to getBooleanProperty(getClassPropertyName(clazz,key)) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    
    Returns:
    the Boolean wrapper for an existing boolean property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getBooleanProperty(String), getClassBooleanProperty(Class, String, boolean)
  - getClassBooleanProperty
```
public static boolean getClassBooleanProperty(java.lang.Class clazz,
                              java.lang.String key,
                              boolean defaultValue)
```
    Equivalent to getBooleanProperty(getClassPropertyName(clazz,key),defaultValue) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    defaultValue - the default value for this property
    
    Returns:
    the property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getBooleanProperty(String, boolean), getClassBooleanProperty(Class, String)
  - getClassIntProperty
```
public static java.lang.Integer getClassIntProperty(java.lang.Class clazz,
                                    java.lang.String key)
```
    Equivalent to getIntProperty(getClassPropertyName(clazz,key)) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    
    Returns:
    the Integer wrapper for an existing integer property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getIntProperty(String), getClassIntProperty(Class, String, int)
  - getClassIntProperty
```
public static int getClassIntProperty(java.lang.Class clazz,
                      java.lang.String key,
                      int defaultValue)
```
    Equivalent to getIntProperty(getClassPropertyName(clazz,key),defaultValue) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    defaultValue - the default value for this property
    
    Returns:
    the property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getIntProperty(String, int), getClassIntProperty(Class, String)
  - getClassLongProperty
```
public static java.lang.Long getClassLongProperty(java.lang.Class clazz,
                                  java.lang.String key)
```
    Equivalent to getLongProperty(getClassPropertyName(clazz,key)) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    
    Returns:
    the Long wrapper for an existing long integer property, null for non-existing property
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getLongProperty(String), getClassLongProperty(Class, String, long)
  - getClassLongProperty
```
public static long getClassLongProperty(java.lang.Class clazz,
                        java.lang.String key,
                        long defaultValue)
```
    Equivalent to getLongProperty(getClassPropertyName(clazz,key),defaultValue) call.
    
    Parameters:
    clazz - the class the property corresponds to which
    key - the property name inside the class (full property name will be clazz.getName() + "." + key)
    defaultValue - the default value for this property
    
    Returns:
    the property with the given name, or defaultValue for it doesn't exist
    
    Throws:
    
    java.lang.NullPointerException - if clazz or key argument is null
    See Also:
    getLongProperty(String, long), getClassLongProperty(Class, String)
  - getClassDebugLevel
```
public static int getClassDebugLevel(java.lang.Class clazz)
```
    Equivalent to getClassIntProperty(clazz, "DEBUG_LEVEL", 0).
    We recommend to use such properties to control whether the class should print additional debug information or no. For example:
```
    public class MyClass {
        public static final int DEBUG_LEVEL = GlobalProperties.getClassDebugLevel(MyClass.class);
        . . .
    }
```
    Parameters:
    clazz - the class the property corresponds to which
    
    Returns:
    the integer property with the name clazz.getName() + ".DEBUG_LEVEL" or 0 if there is no such a property
    
    Throws:
    
    java.lang.NullPointerException - if clazz argument is null
    See Also:
    getClassIntProperty(Class, String, int)
  - setProperty
```
public static java.lang.String setProperty(java.lang.String key,
                           java.lang.String value)
```
    Sets the global string property with the given name key.
    
    Parameters:
    key - the property name
    value - the new value for this property, must not be null
    
    Returns:
    the previous value of the specified property or null if there was no such a property
    
    Throws:
    
    java.lang.NullPointerException - if key or value argument is null
    
    java.lang.IllegalAccessError - if fix() method has been called before
    See Also:
    getProperty(String), setBooleanProperty(String, boolean), setIntProperty(String, int), setLongProperty(String, long), setProperties(Properties), removeProperty(String), fix()
  - setBooleanProperty
```
public static void setBooleanProperty(java.lang.String key,
                      boolean value)
```
    Equivalent to setProperty(key, String.valueOf(value)) call.
    
    Parameters:
    key - the property name
    value - the new value for this property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    setProperty(String, String)
  - setIntProperty
```
public static void setIntProperty(java.lang.String key,
                  int value)
```
    Equivalent to setProperty(key, String.valueOf(value)) call.
    
    Parameters:
    key - the property name
    value - the new value for this property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    setProperty(String, String)
  - setLongProperty
```
public static void setLongProperty(java.lang.String key,
                   long value)
```
    Equivalent to setProperty(key, String.valueOf(value)) call.
    
    Parameters:
    key - the property name
    value - the new value for this property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    See Also:
    setProperty(String, String)
  - removeProperty
```
public static java.lang.String removeProperty(java.lang.String key)
```
    Removes the global property with the given name key.
    
    Parameters:
    key - the property name
    
    Returns:
    the previous value of the specified property or null if there was no such a property
    
    Throws:
    
    java.lang.NullPointerException - if key argument is null
    
    java.lang.IllegalAccessError - if fix() method has been called before
    See Also:
    getProperty(String), setProperty(String, String), setProperties(Properties), removeProperty(String), fix()
  - setProperties
```
public static void setProperties(java.util.Properties properties)
```
    Adds a collection of string properties to the global store. Equivalent to a sequence of setProperty(key,value} calls for all (key, value) pairs contained in properties argument, excepting all pairs where key or value is not a non-null instance of the String class.
    A good usage example for Java applications:
```
    GlobalProperties.setProperties(System.getProperties());
 
```
    Please check that such a call is placed in the very beginning of your application, before any possible usage of these properties. In particular, place this call before any access to classes that probably use these global properties for initializing there statis class variables, such as DEBUG_LEVEL (see getClassDebugLevel(Class)).
    Parameters:
    properties - the collection of string properties that will be added to the current global store
    
    Throws:
    
    java.lang.NullPointerException - if properties argument is null
    
    java.lang.IllegalAccessError - if fix() method has been called before
    See Also:
    getProperty(String), setProperty(String, String), removeProperty(String), fix()
  - fix
```
public static void fix()
```
    Fixes the global store: any modifications become impossible after the first call of this method. An attemt to call setProperty(String, String), removeProperty(String), setProperties(Properties) will lead to IllegalAccessError.
    The call of fix() method never throws exceptions. The second and further its calls do nothing.

Class GlobalProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINE_SEPARATOR

FILE_SEPARATOR

PATH_SEPARATOR

JAVA_NATIVE_ENABLED_PROPERTY_NAME

Method Detail

getProperties

getProperty

getProperty

getBooleanProperty

getBooleanProperty

getIntProperty

getIntProperty

getLongProperty

getLongProperty

getClassPropertyName

getClassProperty

getClassProperty

getClassBooleanProperty

getClassBooleanProperty

getClassIntProperty

getClassIntProperty

getClassLongProperty

getClassLongProperty

getClassDebugLevel

setProperty

setBooleanProperty

setIntProperty

setLongProperty

removeProperty

setProperties

fix