OSI.SystemProperty (binkley-logging 6 API)

java.lang.Object
- java.lang.Enum<OSI.SystemProperty>
- - hm.binkley.util.logging.osi.OSI.SystemProperty

All Implemented Interfaces:

Serializable, Comparable<OSI.SystemProperty>

Enclosing class:

OSI
```
public static enum OSI.SystemProperty
extends Enum<OSI.SystemProperty>
```
SystemProperty defines system properties used by OSI.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`LOG_LEVEL` Adjusts the general logging level when no more specific level is configured for a logger.
`LOGBACK_CONFIGURATION_FILE` Sets the logback configuration resource, rarely changed except for testing.
`LOGBACK_CONTEXT_NAME` Sets the logback context name, equivalently, a short tag identifying the application.
`LOGBACK_DEBUG` Enables logback debugging.
`LOGBACK_INCLUDED_RESOURCE` Sets the resource for additional included logging directives.
`LOGBACK_JANSI` Enables ANSI color codes for logging, including Windows.
`LOGBACK_JMX` Enables JMX support for logback.
`LOGBACK_PROPERTIES_RESOURCE` As an alternative to setting system properties, put properties here.
`LOGBACK_ROOT_APPENDER` Sets the root appender.
`LOGBACK_STYLE` Sets the default logging style.
`LOGBACK_STYLES_RESOURCE` Sets a custom style file for logging, rarely changed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the value to the corresponding system property.
`String`	`get()` Gets the value of the corresponding system property.
`String`	`key()` Gets the key string used with system properties.
`void`	`set(String value)` Sets the value of the corresponding system property, or clears it if `null`.
`String`	`toString()`
`static OSI.SystemProperty`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OSI.SystemProperty[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - LOGBACK_CONFIGURATION_FILE
```
public static final OSI.SystemProperty LOGBACK_CONFIGURATION_FILE
```
    Sets the logback configuration resource, rarely changed except for testing. Default is "osi-logback.xml".
    Note this is defined by logback. Although looked for on the classpath, logback names this "configurationFile".
    
    See Also:
    
    OSI.enable()
  - LOGBACK_CONTEXT_NAME
```
public static final OSI.SystemProperty LOGBACK_CONTEXT_NAME
```
    Sets the logback context name, equivalently, a short tag identifying the application. Default is "default".
    Use this to distinguish merging of logging from multiple application.
    
    See Also:
    
    Setting the context name
  - LOGBACK_PROPERTIES_RESOURCE
```
public static final OSI.SystemProperty LOGBACK_PROPERTIES_RESOURCE
```
    As an alternative to setting system properties, put properties here. Default is "osi-logback.properties" in the classpath root.
    These cannot, however, override these system properties which are used before the properties resource is loaded:
    - logback.configurationFile
    - logback.propertiesResource
    - logback.debug
  - LOGBACK_STYLES_RESOURCE
```
public static final OSI.SystemProperty LOGBACK_STYLES_RESOURCE
```
    Sets a custom style file for logging, rarely changed. Default is "osi-logback-style.properties".
    
    See Also:
    
    LOGBACK_STYLES_RESOURCE
  - LOGBACK_STYLE
```
public static final OSI.SystemProperty LOGBACK_STYLE
```
    Sets the default logging style. Default is "standard".
    See osi-logback-styles.properties for help and details.
    
    See Also:
    
    LOGBACK_STYLES_RESOURCE
  - LOGBACK_INCLUDED_RESOURCE
```
public static final OSI.SystemProperty LOGBACK_INCLUDED_RESOURCE
```
    Sets the resource for additional included logging directives. Default is "osi-logback-included.xml".
    This is often changed (or one named osi-logback-included.xml is provided in the application class path) to control logging such as changing log levels.
    
    See Also:
    
    LOGBACK_INCLUDED_RESOURCE
  - LOGBACK_JMX
```
public static final OSI.SystemProperty LOGBACK_JMX
```
    Enables JMX support for logback. Default is "true".
  - LOGBACK_DEBUG
```
public static final OSI.SystemProperty LOGBACK_DEBUG
```
    Enables logback debugging. Default is "false".
    Enabling logback debugging sets log.level to "DEBUG".
    
    See Also:
    
    LOG_LEVEL
  - LOG_LEVEL
```
public static final OSI.SystemProperty LOG_LEVEL
```
    Adjusts the general logging level when no more specific level is configured for a logger. Default is "WARN".
    
    See Also:
    
    Level
  - LOGBACK_ROOT_APPENDER
```
public static final OSI.SystemProperty LOGBACK_ROOT_APPENDER
```
    Sets the root appender. Default is "console".
    Use in combination with a custom appender defined in osi-logback-included.xml.
    
    See Also:
    
    LOGBACK_INCLUDED_RESOURCE
  - LOGBACK_JANSI
```
public static final OSI.SystemProperty LOGBACK_JANSI
```
    Enables ANSI color codes for logging, including Windows. Default is "false".
- Method Detail
  - values
```
public static OSI.SystemProperty[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (OSI.SystemProperty c : OSI.SystemProperty.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OSI.SystemProperty valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - key
```
@Nonnull
public final String key()
```
    Gets the key string used with system properties.
    
    Returns:
    
    the key string, never missing
  - get
```
@Nullable
public final String get()
```
    Gets the value of the corresponding system property.
    
    Returns:
    
    the system property value or null if undefined
  - set
```
public final void set(@Nullable
                      String value)
```
    Sets the value of the corresponding system property, or clears it if null.
    
    Parameters:
    
    value - the system property value or null to clear
  - clear
```
public final void clear()
```
    Clears the value to the corresponding system property.
  - toString
```
@Nonnull
public final String toString()
```
    Overrides:
    
    toString in class Enum<OSI.SystemProperty>

Enum OSI.SystemProperty

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LOGBACK_CONFIGURATION_FILE

LOGBACK_CONTEXT_NAME

LOGBACK_PROPERTIES_RESOURCE

LOGBACK_STYLES_RESOURCE

LOGBACK_STYLE

LOGBACK_INCLUDED_RESOURCE

LOGBACK_JMX

LOGBACK_DEBUG

LOG_LEVEL

LOGBACK_ROOT_APPENDER

LOGBACK_JANSI

Method Detail

values

valueOf

key

get

set

clear

toString