Config (Better Checks 1.0 API)

java.lang.Object
- ch.trick17.betterchecks.Config

```
@GwtCompatible
public final class Config
extends Object
```
Provides access to the configuration of the Better Checks library.
As documented in the Check class, the library can only be configured via a config file on the classpath. The file must be named "better-checks-config".properties (without the quotes, of course!) and must be located in the classpath root. The config file is loaded via ResourceBundles, so localization is supported. However, it is questionable to display exception messages directly to the user, so this might not be commonly used.
Here is what a config file might look like:
```
 cleanStackTraces = false
 defaultArgumentName = le argument
 ARG_POSITIVE.format = %s should -(not )-be positive
 ARG_NEGATIVE.format = %s should -(not )-be negative
 
```
The getConfig() method provides read access to the config singleton. To assert that the your config file has been loaded, you may use the isLoadedFromConfigFile() method.
For more information, refer to the documentation of the isCleanStackTracesEnabled(), getDefaultArgumentName() and getMessageFormat(MessageType, boolean) methods.
Author:

Michael Faes

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLEAN_STACK_TRACES_ENABLED_KEY` The key for disabling stack trace cleaning in the config file: `"cleanStackTraces"` (without quotes).
`static String`	`CONFIG_BASE_NAME` The base name of the config file for this library: `"better-checks-config"`
`static String`	`DEFAULT_ARG_NAME_KEY` The key for setting the default argument name in the config file: `"defaultArgumentName"` (without quotes).
`static boolean`	`DEFAULT_CLEAN_STRACK_TRACES_ENABLED` The default setting for for stack trace cleaning, which is true .
`static String`	`DEFAULT_DEFAULT_ARG_NAME` The default setting for the default argument name, which is "the argument" .

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Config`	`getConfig()` Returns the Better Checks config singleton.
`String`	`getDefaultArgumentName()` Returns the default argument name used in exception messages.
`String`	`getMessageFormat(MessageType type, boolean inverted)` Returns the exception message format for the given `MessageType`.
`boolean`	`isCleanStackTracesEnabled()` Indicates whether stack trace cleaning is enabled.
`boolean`	`isLoadedFromConfigFile()` Indicates whether a valid config file was loaded.

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

- Field Detail
  - CONFIG_BASE_NAME
```
@GwtIncompatible(value="Configuration not supported with GWT")
public static final String CONFIG_BASE_NAME
```
    The base name of the config file for this library: "better-checks-config"
    
    See Also:
    
    Constant Field Values
  - CLEAN_STACK_TRACES_ENABLED_KEY
```
@GwtIncompatible(value="Configuration not supported with GWT")
public static final String CLEAN_STACK_TRACES_ENABLED_KEY
```
    The key for disabling stack trace cleaning in the config file: "cleanStackTraces" (without quotes).
    
    See Also:
    
    isCleanStackTracesEnabled(), Constant Field Values
  - DEFAULT_ARG_NAME_KEY
```
@GwtIncompatible(value="Configuration not supported with GWT")
public static final String DEFAULT_ARG_NAME_KEY
```
    The key for setting the default argument name in the config file: "defaultArgumentName" (without quotes).
    
    See Also:
    
    getDefaultArgumentName(), Constant Field Values
  - DEFAULT_DEFAULT_ARG_NAME
```
public static final String DEFAULT_DEFAULT_ARG_NAME
```
    The default setting for the default argument name, which is "the argument" . (Yes, that is a meta-default.)
    
    See Also:
    
    getDefaultArgumentName(), Constant Field Values
  - DEFAULT_CLEAN_STRACK_TRACES_ENABLED
```
public static final boolean DEFAULT_CLEAN_STRACK_TRACES_ENABLED
```
    The default setting for for stack trace cleaning, which is true .
    
    See Also:
    
    isCleanStackTracesEnabled(), Constant Field Values
- Method Detail
  - getConfig
```
public static Config getConfig()
```
    Returns the Better Checks config singleton. It is read-only, the only way to configure the library is using a properties file on the classpath.
    
    Returns:
    
    The config singleton
    
    See Also:
    
    Config
  - isLoadedFromConfigFile
```
public boolean isLoadedFromConfigFile()
```
    Indicates whether a valid config file was loaded.
    Note that the config file may define as many and as few properties as desired. The rest of the properties are set to the default value.
    
    Returns:
    
    true iff a config file was loaded.
  - isCleanStackTracesEnabled
```
public boolean isCleanStackTracesEnabled()
```
    Indicates whether stack trace cleaning is enabled. See the documentation of Check for more information.
    The default value is true. To override this, set the "cleanStackTraces" property in the config file.
    
    Returns:
    
    true if stack trace cleaning is enabled.
  - getDefaultArgumentName
```
public String getDefaultArgumentName()
```
    Returns the default argument name used in exception messages. This name is used when arguments are not explicitly named using the BaseCheck.named(String) modifier.
    The default value (meaning the default default name) is "the argument". To override this, set the "defaultArgumentName" property in the config file.
    
    Returns:
    
    The default argument name for exception messages
  - getMessageFormat
```
public String getMessageFormat(MessageType type,
                               boolean inverted)
```
    Returns the exception message format for the given MessageType. The formats are format strings defined by the Formatter class.
    Besides the message type, a second parameter affects the exception message format: Whether or not the check was inverted. The messages for inverted checks are also inverted, typically with an additional or missing "not".
    To combine two such message formats, the library internally makes use of a "meta" format that encompasses both versions. This meta format is simple: message parts that should only be used in the positive (non-inverted) version are enclosed in +( and )+. Analogically, parts for the negative (inverted) version are enclosed in -( and )-. Here's an example:
    %s must +(not )+be null-( (value: %s))-
    The positive format here is %s must not be null and the negative version is %s must be null (value: %s). In both cases the first %s will be replaced with the argument name and in the negative version, the second %s will be replaced with the actual value of the argument.
    The default meta format for each message type is given by the MessageType.getDefaultFormat() method. To override a specific format, add a property in the config file with a key named MESSAGE_TYPE.format (where MESSAGE_TYPE is the string representation of one of the MessageType enum values) and a value containing the meta format for that type.
    
    Parameters:
    
    type - The message type
    
    inverted - If true, the message format is inverted to reflect an inverted check.
    
    Returns:
    
    The message format as a Formatter format string

Class Config

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_BASE_NAME

CLEAN_STACK_TRACES_ENABLED_KEY

DEFAULT_ARG_NAME_KEY

DEFAULT_DEFAULT_ARG_NAME

DEFAULT_CLEAN_STRACK_TRACES_ENABLED

Method Detail

getConfig

isLoadedFromConfigFile

isCleanStackTracesEnabled

getDefaultArgumentName

getMessageFormat