Package oshi.util

Class GlobalConfig


  • @NotThreadSafe
    public final class GlobalConfig
    extends java.lang.Object
    The global configuration utility. See src/main/resources/oshi.properties for default values.

    This class is not thread safe if methods manipulating the configuration are used. These methods are intended for use by a single thread at startup, before instantiation of any other OSHI classes. OSHI does not guarantee re- reading of any configuration changes.

    • Field Detail

      • CONFIG

        private static final java.util.Properties CONFIG
      • OSHI_UTIL_MEMOIZER_EXPIRATION

        public static final java.lang.String OSHI_UTIL_MEMOIZER_EXPIRATION
        See Also:
        Constant Field Values
      • OSHI_UTIL_WMI_TIMEOUT

        public static final java.lang.String OSHI_UTIL_WMI_TIMEOUT
        See Also:
        Constant Field Values
      • OSHI_UTIL_PROC_PATH

        public static final java.lang.String OSHI_UTIL_PROC_PATH
        See Also:
        Constant Field Values
      • OSHI_UTIL_SYS_PATH

        public static final java.lang.String OSHI_UTIL_SYS_PATH
        See Also:
        Constant Field Values
      • OSHI_UTIL_DEV_PATH

        public static final java.lang.String OSHI_UTIL_DEV_PATH
        See Also:
        Constant Field Values
      • OSHI_PSEUDO_FILESYSTEM_TYPES

        public static final java.lang.String OSHI_PSEUDO_FILESYSTEM_TYPES
        See Also:
        Constant Field Values
      • OSHI_NETWORK_FILESYSTEM_TYPES

        public static final java.lang.String OSHI_NETWORK_FILESYSTEM_TYPES
        See Also:
        Constant Field Values
      • OSHI_OS_LINUX_ALLOWUDEV

        public static final java.lang.String OSHI_OS_LINUX_ALLOWUDEV
        See Also:
        Constant Field Values
      • OSHI_OS_LINUX_PROCFS_LOGWARNING

        public static final java.lang.String OSHI_OS_LINUX_PROCFS_LOGWARNING
        See Also:
        Constant Field Values
      • OSHI_OS_MAC_SYSCTL_LOGWARNING

        public static final java.lang.String OSHI_OS_MAC_SYSCTL_LOGWARNING
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_EVENTLOG

        public static final java.lang.String OSHI_OS_WINDOWS_EVENTLOG
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_PROCSTATE_SUSPENDED

        public static final java.lang.String OSHI_OS_WINDOWS_PROCSTATE_SUSPENDED
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_COMMANDLINE_BATCH

        public static final java.lang.String OSHI_OS_WINDOWS_COMMANDLINE_BATCH
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_HKEYPERFDATA

        public static final java.lang.String OSHI_OS_WINDOWS_HKEYPERFDATA
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_LEGACY_SYSTEM_COUNTERS

        public static final java.lang.String OSHI_OS_WINDOWS_LEGACY_SYSTEM_COUNTERS
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_LOADAVERAGE

        public static final java.lang.String OSHI_OS_WINDOWS_LOADAVERAGE
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_CPU_UTILITY

        public static final java.lang.String OSHI_OS_WINDOWS_CPU_UTILITY
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_PERFDISK_DIABLED

        public static final java.lang.String OSHI_OS_WINDOWS_PERFDISK_DIABLED
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_PERFOS_DIABLED

        public static final java.lang.String OSHI_OS_WINDOWS_PERFOS_DIABLED
        See Also:
        Constant Field Values
      • OSHI_OS_WINDOWS_PERFPROC_DIABLED

        public static final java.lang.String OSHI_OS_WINDOWS_PERFPROC_DIABLED
        See Also:
        Constant Field Values
      • OSHI_OS_UNIX_WHOCOMMAND

        public static final java.lang.String OSHI_OS_UNIX_WHOCOMMAND
        See Also:
        Constant Field Values
      • OSHI_OS_SOLARIS_ALLOWKSTAT2

        public static final java.lang.String OSHI_OS_SOLARIS_ALLOWKSTAT2
        See Also:
        Constant Field Values
    • Constructor Detail

      • GlobalConfig

        private GlobalConfig()
    • Method Detail

      • get

        public static java.lang.String get​(java.lang.String key)
        Get the property associated with the given key.
        Parameters:
        key - The property key
        Returns:
        The property value if it exists, or null otherwise
      • get

        public static java.lang.String get​(java.lang.String key,
                                           java.lang.String def)
        Get the String property associated with the given key.
        Parameters:
        key - The property key
        def - The default value
        Returns:
        The property value or the given default if not found
      • get

        public static int get​(java.lang.String key,
                              int def)
        Get the int property associated with the given key.
        Parameters:
        key - The property key
        def - The default value
        Returns:
        The property value or the given default if not found
      • get

        public static double get​(java.lang.String key,
                                 double def)
        Get the double property associated with the given key.
        Parameters:
        key - The property key
        def - The default value
        Returns:
        The property value or the given default if not found
      • get

        public static boolean get​(java.lang.String key,
                                  boolean def)
        Get the boolean property associated with the given key.
        Parameters:
        key - The property key
        def - The default value
        Returns:
        The property value or the given default if not found
      • set

        public static void set​(java.lang.String key,
                               java.lang.Object val)
        Set the given property, overwriting any existing value. If the given value is null, the property is removed.
        Parameters:
        key - The property key
        val - The new value
      • remove

        public static void remove​(java.lang.String key)
        Reset the given property to its default value.
        Parameters:
        key - The property key
      • clear

        public static void clear()
        Clear the configuration.
      • load

        public static void load​(java.util.Properties properties)
        Load the given Properties into the global configuration.
        Parameters:
        properties - The new properties