com.wowza.gocoder.sdk.api.logging

Class WOWZLog

java.lang.Object

com.wowza.gocoder.sdk.api.logging.WOWZLog

public final class WOWZLog
extends java.lang.Object

The WOWZLog class provides a collection of static API methods for sending logging output. For example:

         private final static String TAG = "MyClassName";

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.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 Enables logging.
static int	MAX_LOG_LEVEL
static int	MIN_LOG_LEVEL

Constructor Summary

Constructors

Constructor and Description
WOWZLog()

Method Summary

Modifier and Type	Method and Description
static void	debug(java.lang.String message) Sends a debug log message with the default logging tag.
static void	debug(java.lang.String tag, java.lang.String message) Sends a debug log message.
static void	error(java.lang.String message) Sends an error message with the default logging tag.
static void	error(java.lang.String tag, java.lang.String message) Sends an error message.
static void	error(java.lang.String tag, java.lang.String message, java.lang.Throwable throwable) Sends an error message with an exception to log.
static void	error(java.lang.String tag, java.lang.Throwable throwable) Sends an exception to log.
static void	error(java.lang.String tag, WOWZError error) Sends an error message.
static void	error(java.lang.String tag, WOWZError error, java.lang.Throwable throwable) Sends an error message.
static void	error(java.lang.Throwable throwable) Sends an exception to log with the default logging tag.
static void	error(WOWZError error) Sends an error message with the default logging tag.
static void	error(WOWZError error, java.lang.Throwable throwable) Sends an error message with the default logging tag.
static WOWZLogger	getLogger() Returns the currently registered logger instance.
static void	info(java.lang.String message) Sends an informational log message with the default logging tag.
static void	info(java.lang.String tag, java.lang.String message) Sends an informational log message.
static boolean	isValidLogLevel(int logLevel)
static void	registerLogger(WOWZLogger logger) Registers a custom logger instance.
static void	unregisterLogger(WOWZLogger logger) Unregisters a custom logger instance.
static void	verbose(java.lang.String message) Sends an informational log message with the default logging tag.
static void	verbose(java.lang.String tag, java.lang.String message) Sends a verbose log message.
static void	warn(java.lang.String message) Sends a warning log message with the default logging tag.
static void	warn(java.lang.String tag, java.lang.String message) Sends a warning log message.
static void	warn(java.lang.String tag, WOWZError warning) Sends a warning log message.
static void	warn(WOWZError warning) Sends a warning 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 java.lang.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

Enables logging. If false, the default, no log output is produced.

Constructor Detail

WOWZLog

public WOWZLog()

Method Detail

isValidLogLevel

public static boolean isValidLogLevel(int logLevel)

registerLogger

public static void registerLogger(WOWZLogger logger)

Registers a custom logger instance. See WOWZLogger for information on writing a custom logger.

Parameters:

logger - An instance of a custom logger class.

unregisterLogger

public static void unregisterLogger(WOWZLogger logger)

Unregisters a custom logger instance.

Parameters:

logger - An instance of a previously registered custom logger class.

getLogger

public static WOWZLogger getLogger()

Returns the currently registered logger instance.

Returns:

The currently registered logger instance.

verbose

public static void verbose(java.lang.String tag,
                           java.lang.String message)

Sends a verbose log message.

Parameters:

tag - The source of a log message.

message - The log message.

verbose

public static void verbose(java.lang.String message)

Sends an informational log message with the default logging tag.

Parameters:

message - The log message.

info

public static void info(java.lang.String tag,
                        java.lang.String message)

Sends an informational log message.

Parameters:

tag - The source of a log message.

message - The log message.

info

public static void info(java.lang.String message)

Sends an informational log message with the default logging tag.

Parameters:

message - The log message.

debug

public static void debug(java.lang.String tag,
                         java.lang.String message)

Sends a debug log message.

Parameters:

tag - The source of a log message.

message - The log message.

debug

public static void debug(java.lang.String message)

Sends a debug log message with the default logging tag.

Parameters:

message - The log message.

warn

public static void warn(java.lang.String tag,
                        java.lang.String message)

Sends a warning log message.

Parameters:

tag - The source of a log message.

message - The log message.

warn

public static void warn(java.lang.String message)

Sends a warning log message with the default logging tag.

Parameters:

message - The log message.

warn

public static void warn(java.lang.String tag,
                        WOWZError warning)

Sends a warning log message.

Parameters:

warning - An instance of the WOWZError class.

warn

public static void warn(WOWZError warning)

Sends a warning message with the default logging tag.

Parameters:

warning - An instance of the WOWZError class.

error

public static void error(java.lang.String tag,
                         java.lang.String message)

Sends an error message.

Parameters:

tag - The source of a log message.

message - The log message.

error

public static void error(java.lang.String tag,
                         java.lang.String message,
                         java.lang.Throwable throwable)

Sends an error message with an exception to log.

Parameters:

tag - The source of a log message.

message - The log message.

throwable - An exception to log.

error

public static void error(java.lang.String message)

Sends an error message with the default logging tag.

Parameters:

message - The log message.

error

public static void error(java.lang.String tag,
                         WOWZError error)

Sends an error message.

Parameters:

tag - The source of a log message.

error - An instance of the WOWZError class.

error

public static void error(java.lang.String tag,
                         WOWZError error,
                         java.lang.Throwable throwable)

Sends an error message.

Parameters:

tag - The source of a log message.

error - An instance of the WOWZError class.

throwable - An exception to log.

error

public static void error(WOWZError error,
                         java.lang.Throwable throwable)

Sends an error message with the default logging tag.

Parameters:

error - An instance of the WOWZError class.

throwable - An exception to log.

error

public static void error(WOWZError error)

Sends an error message with the default logging tag.

Parameters:

error - An instance of the WOWZError class.

error

public static void error(java.lang.String tag,
                         java.lang.Throwable throwable)

Sends an exception to log.

Parameters:

tag - The source of a log message.

throwable - An exception to log.

error

public static void error(java.lang.Throwable throwable)

Sends an exception to log with the default logging tag.

Parameters:

throwable - An exception to log.