MessageConsole (SKB Interfaces 0.0.1 API)

Object
- MessageConsole

```
public final class MessageConsole
extends Object
```
Utilities for message input/output to a console using loggers. The interface provides settings and method to print information, warning, error, trace, and debug messages. While information, warnings, and errors are obviously of different type, trace and debug messages are arbitrary (i.e. whatever you want it to be). This interface only provides means to separate those types, and handle them independently. This also means that, in contrast to logging frameworks, there is no hierarchy of message types. The behavior of each type can be set separately, without impacting the behavior of any other type. Additionally, an über flag is provided to switch off all message printing.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`PRINT_DEBUG_MESSAGES` Print info debug flag.
`static boolean`	`PRINT_ERROR_MESSAGES` Print error message flag.
`static boolean`	`PRINT_INFO_MESSAGES` Print info message flag.
`static boolean`	`PRINT_MESSAGES` Print message flag.
`static boolean`	`PRINT_TRACE_MESSAGES` Print info trace flag.
`static boolean`	`PRINT_WARNING_MESSAGES` Print warning message flag.

Constructor Summary

Constructors
Constructor and Description

MessageConsole()
Constructor, throws exception since this class should not be instantiated.

Constructors
Constructor and Description
`MessageConsole()` Constructor, throws exception since this class should not be instantiated.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`conDebug(String msg)` Prints a debug message to standard out.
`static void`	`conDebug(String msg, Object... args)` Prints a debug message to to standard out using a `FormattingTuple`.
`static void`	`conError(String msg)` Prints an error message to standard error.
`static void`	`conError(String msg, Object... args)` Prints an error message to to standard error using a `FormattingTuple`.
`static void`	`conInfo(String msg)` Prints an info message to standard out.
`static void`	`conInfo(String msg, Object... args)` Prints an info message to to standard out using a `FormattingTuple`.
`static void`	`conTrace(String msg)` Prints a trace message to standard out.
`static void`	`conTrace(String msg, Object... args)` Prints a trace message to to standard out using a `FormattingTuple`.
`static void`	`conWarn(String msg)` Prints a warning message to to standard out.
`static void`	`conWarn(String msg, Object... args)` Prints a warning message to to standard out using a `FormattingTuple`.
`static String`	`getDefaultEncoding()` Returns the default runtime encoding.
`static BufferedReader`	`getStdIn(String appName)` Returns a new buffered reader for standard in, using UTF-8 encoding.

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

- Field Detail
  - PRINT_MESSAGES
```
public static boolean PRINT_MESSAGES
```
    Print message flag.
    
    This flag is used as an über flag for printing messages. If set to true, messages in general can be printed using the methods in this interface. If set to false, no messages at all should be printed by any method in this interface.
    
    The flag is static, so it is the same for all applications running in the JVM.
  - PRINT_ERROR_MESSAGES
```
public static boolean PRINT_ERROR_MESSAGES
```
    Print error message flag.
    
    Errors will be printed to standard error by the error methods in this interface. If this flag is false, no errors will be printed. If this flag is false and PRINT_MESSAGES is false, no error messages will be printed. If this flag is true and PRINT_MESSAGES is true, error messages will be printed.
  - PRINT_WARNING_MESSAGES
```
public static boolean PRINT_WARNING_MESSAGES
```
    Print warning message flag.
    
    Warnings will be printed to standard out by the warning methods in this interface. If this flag is false, no warnings will be printed. If this flag is false and PRINT_MESSAGES is false, no warning messages will be printed. If this flag is true and PRINT_MESSAGES is true, warning messages will be printed.
  - PRINT_INFO_MESSAGES
```
public static boolean PRINT_INFO_MESSAGES
```
    Print info message flag.
    
    Info messages will be printed to standard out by the info methods in this interface. If this flag is false, no info messages will be printed. If this flag is false and PRINT_MESSAGES is false, no info messages will be printed. If this flag is true and PRINT_MESSAGES is true, info messages will be printed.
  - PRINT_TRACE_MESSAGES
```
public static boolean PRINT_TRACE_MESSAGES
```
    Print info trace flag.
    
    Trace messages will be printed to standard out by the info methods in this interface. If this flag is false, no trace messages will be printed. If this flag is false and PRINT_MESSAGES is false, no trace messages will be printed. If this flag is true and PRINT_MESSAGES is true, trace messages will be printed.
  - PRINT_DEBUG_MESSAGES
```
public static boolean PRINT_DEBUG_MESSAGES
```
    Print info debug flag.
    
    Debug messages will be printed to standard out by the info methods in this interface. If this flag is false, no debug messages will be printed. If this flag is false and PRINT_MESSAGES is false, no debug messages will be printed. If this flag is true and PRINT_MESSAGES is true, debug messages will be printed.
- Constructor Detail
  - MessageConsole
```
public MessageConsole()
```
    Constructor, throws exception since this class should not be instantiated.
    
    Throws:
    
    UnsupportedOperationException - be default
- Method Detail
  - conInfo
```
public static void conInfo(String msg)
```
    Prints an info message to standard out.
    
    Parameters:
    
    msg - info message to print
  - conInfo
```
public static void conInfo(String msg,
                           Object... args)
```
    Prints an info message to to standard out using a FormattingTuple.
    
    Parameters:
    
    msg - info message to print
    
    args - arguments for the message
  - conWarn
```
public static void conWarn(String msg)
```
    Prints a warning message to to standard out.
    
    Parameters:
    
    msg - warning message to print
  - conWarn
```
public static void conWarn(String msg,
                           Object... args)
```
    Prints a warning message to to standard out using a FormattingTuple.
    
    Parameters:
    
    msg - warning message to print
    
    args - arguments for the message
  - conError
```
public static void conError(String msg)
```
    Prints an error message to standard error.
    
    Parameters:
    
    msg - error message to print
  - conError
```
public static void conError(String msg,
                            Object... args)
```
    Prints an error message to to standard error using a FormattingTuple.
    
    Parameters:
    
    msg - error message to print
    
    args - arguments for the message
  - conTrace
```
public static void conTrace(String msg)
```
    Prints a trace message to standard out.
    
    Parameters:
    
    msg - trace message to print
  - conTrace
```
public static void conTrace(String msg,
                            Object... args)
```
    Prints a trace message to to standard out using a FormattingTuple.
    
    Parameters:
    
    msg - trace message to print
    
    args - arguments for the message
  - conDebug
```
public static void conDebug(String msg)
```
    Prints a debug message to standard out.
    
    Parameters:
    
    msg - debug message to print
  - conDebug
```
public static void conDebug(String msg,
                            Object... args)
```
    Prints a debug message to to standard out using a FormattingTuple.
    
    Parameters:
    
    msg - debug message to print
    
    args - arguments for the message
  - getDefaultEncoding
```
public static String getDefaultEncoding()
```
    Returns the default runtime encoding.
    
    Returns:
    
    string with the encoding
  - getStdIn
```
public static BufferedReader getStdIn(String appName)
```
    Returns a new buffered reader for standard in, using UTF-8 encoding.
    
    Parameters:
    
    appName - application name for error messages
    
    Returns:
    
    new buffered reader for standard in using UTF-8 encoding, null if error occurred

Class MessageConsole

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

PRINT_MESSAGES

PRINT_ERROR_MESSAGES

PRINT_WARNING_MESSAGES

PRINT_INFO_MESSAGES

PRINT_TRACE_MESSAGES

PRINT_DEBUG_MESSAGES

Constructor Detail

MessageConsole

Method Detail

conInfo

conInfo

conWarn

conWarn

conError

conError

conTrace

conTrace

conDebug

conDebug

getDefaultEncoding

getStdIn