WZLog (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.logging.WZLog

public final class WZLog
extends Object

The WZLog class provides a collection of static API methods for sending logging output.

Usage example:

         private final static String TAG = "MyClassName";

         WZLog.LOGGING_ENABLED = true;
         WZLog.info(TAG, "Become a Wowza Ninja today!");
         try {
             ... code which throws an exception ...
         } catch (Exception e) {
             WZLog.error(TAG, "An error occurred", e);
         }

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOGGING_TAG`
`static int`	`LOG_LEVEL_DEBUG`
`static int`	`LOG_LEVEL_ERROR`
`static int`	`LOG_LEVEL_INFO`
`static int`	`LOG_LEVEL_VERBOSE`
`static int`	`LOG_LEVEL_WARN`
`static boolean`	`LOGGING_ENABLED` The SDK will not produce log output if `WZLog.LOGGING_ENABLED` is set to `false` (the default).
`static int`	`MAX_LOG_LEVEL`
`static int`	`MIN_LOG_LEVEL`

Constructor Summary

Constructors
Constructor and Description

WZLog()

Constructors
Constructor and Description
`WZLog()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`debug(String message)` Send an debug-level log message with the default logging tag
`static void`	`debug(String tag, String message)` Send an debug-level log message
`static void`	`error(String message)` Send an error message with the default logging tag
`static void`	`error(String tag, String message)` Send an error message
`static void`	`error(String tag, String message, Throwable throwable)` Send an error message with an exception to log
`static void`	`error(String tag, Throwable throwable)` Send an exception to log
`static void`	`error(String tag, WZError error)` Send an error message
`static void`	`error(String tag, WZError error, Throwable throwable)` Send an error message
`static void`	`error(Throwable throwable)` Send an exception to log with the default logging tag
`static void`	`error(WZError error)` Send an error message with the default logging tag
`static void`	`error(WZError error, Throwable throwable)` Send an error message with the default logging tag
`static WZLogger`	`getLogger()` Returns the currently registered logger instance.
`static void`	`info(String message)` Send an informational-level log message with the default logging tag
`static void`	`info(String tag, String message)` Send an informational-level log message
`static boolean`	`isValidLogLevel(int logLevel)`
`static void`	`registerLogger(WZLogger logger)` Register a custom logger instance.
`static void`	`unregisterLogger(WZLogger logger)` Unregister a custom logger instance.
`static void`	`verbose(String message)` Send an informational-level log message with the default logging tag
`static void`	`verbose(String tag, String message)` Send a verbose-level log message
`static void`	`warn(String message)` Send an warning-level log message with the default logging tag
`static void`	`warn(String tag, String message)` Send an warning-level log message
`static void`	`warn(String tag, WZError warning)` Send an warning-level log message
`static void`	`warn(WZError warning)` Send a warning-level message with the default logging tag

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

- Field Detail
  - DEFAULT_LOGGING_TAG
```
public static final String DEFAULT_LOGGING_TAG
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_VERBOSE
```
public static final int LOG_LEVEL_VERBOSE
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_DEBUG
```
public static final int LOG_LEVEL_DEBUG
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_INFO
```
public static final int LOG_LEVEL_INFO
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_WARN
```
public static final int LOG_LEVEL_WARN
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_ERROR
```
public static final int LOG_LEVEL_ERROR
```
    See Also:
    
    Constant Field Values
  - MIN_LOG_LEVEL
```
public static final int MIN_LOG_LEVEL
```
    See Also:
    
    Constant Field Values
  - MAX_LOG_LEVEL
```
public static final int MAX_LOG_LEVEL
```
    See Also:
    
    Constant Field Values
  - LOGGING_ENABLED
```
public static boolean LOGGING_ENABLED
```
    The SDK will not produce log output if WZLog.LOGGING_ENABLED is set to false (the default).
- Constructor Detail
  - WZLog
```
public WZLog()
```
- Method Detail
  - isValidLogLevel
```
public static boolean isValidLogLevel(int logLevel)
```
  - registerLogger
```
public static void registerLogger(WZLogger logger)
```
    Register a custom logger instance. See WZLogger for information on writing a custom logger.
    
    Parameters:
    
    logger - An instance of a custom logger class
  - unregisterLogger
```
public static void unregisterLogger(WZLogger logger)
```
    Unregister a custom logger instance.
    
    Parameters:
    
    logger - An instance of a custom logger class previously registered with registerLogger(WZLogger)
  - getLogger
```
public static WZLogger getLogger()
```
    Returns the currently registered logger instance.
    
    Returns:
    
    The currently registered logger instance.
  - verbose
```
public static void verbose(String tag,
                           String message)
```
    Send a verbose-level log message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
  - verbose
```
public static void verbose(String message)
```
    Send an informational-level log message with the default logging tag
    
    Parameters:
    
    message - The log message
  - info
```
public static void info(String tag,
                        String message)
```
    Send an informational-level log message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
  - info
```
public static void info(String message)
```
    Send an informational-level log message with the default logging tag
    
    Parameters:
    
    message - The log message
  - debug
```
public static void debug(String tag,
                         String message)
```
    Send an debug-level log message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
  - debug
```
public static void debug(String message)
```
    Send an debug-level log message with the default logging tag
    
    Parameters:
    
    message - The log message
  - warn
```
public static void warn(String tag,
                        String message)
```
    Send an warning-level log message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
  - warn
```
public static void warn(String message)
```
    Send an warning-level log message with the default logging tag
    
    Parameters:
    
    message - The log message
  - warn
```
public static void warn(String tag,
                        WZError warning)
```
    Send an warning-level log message
    
    Parameters:
    
    warning - An instance of the WZError class
  - warn
```
public static void warn(WZError warning)
```
    Send a warning-level message with the default logging tag
    
    Parameters:
    
    warning - An instance of the WZError class
  - error
```
public static void error(String tag,
                         String message)
```
    Send an error message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
  - error
```
public static void error(String tag,
                         String message,
                         Throwable throwable)
```
    Send an error message with an exception to log
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    message - The log message
    
    throwable - An exception to log
  - error
```
public static void error(String message)
```
    Send an error message with the default logging tag
    
    Parameters:
    
    message - The log message
  - error
```
public static void error(String tag,
                         WZError error)
```
    Send an error message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    error - An instance of the WZError class
  - error
```
public static void error(String tag,
                         WZError error,
                         Throwable throwable)
```
    Send an error message
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    error - An instance of the WZError class
    
    throwable - An exception to log
  - error
```
public static void error(WZError error,
                         Throwable throwable)
```
    Send an error message with the default logging tag
    
    Parameters:
    
    error - An instance of the WZError class
    
    throwable - An exception to log
  - error
```
public static void error(WZError error)
```
    Send an error message with the default logging tag
    
    Parameters:
    
    error - An instance of the WZError class
  - error
```
public static void error(String tag,
                         Throwable throwable)
```
    Send an exception to log
    
    Parameters:
    
    tag - Identifies the source of a log message.
    
    throwable - An exception to log
  - error
```
public static void error(Throwable throwable)
```
    Send an exception to log with the default logging tag
    
    Parameters:
    
    throwable - An exception to log

Class WZLog

Usage example:

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOGGING_TAG

LOG_LEVEL_VERBOSE

LOG_LEVEL_DEBUG

LOG_LEVEL_INFO

LOG_LEVEL_WARN

LOG_LEVEL_ERROR

MIN_LOG_LEVEL

MAX_LOG_LEVEL

LOGGING_ENABLED

Constructor Detail

WZLog

Method Detail

isValidLogLevel

registerLogger

unregisterLogger

getLogger

verbose

verbose

info

info

debug

debug

warn

warn

warn

warn

error

error

error

error

error

error

error

error

error