com.amazonaws.kinesisvideo.common.logging

Class Log

java.lang.Object

com.amazonaws.kinesisvideo.common.logging.Log

public class Log
extends Object

Kinesis Video Streams common codebase. Logging class for Kinesis Video Streams codebase. The underlying logger can be different for different platforms - i.e. LogCat for Android.

Field Summary

Fields

Modifier and Type	Field and Description
static OutputChannel	SYSTEM_OUT OutputChannel implementation based on System.out.

Constructor Summary

Constructors

Constructor and Description
Log(OutputChannel outputChannel) Creates a new instance of the class using defaults
Log(OutputChannel outputChannel, LogLevel currentLogLevel, String tag) Creates a new instance of the class

Method Summary

Modifier and Type	Method and Description
void	assrt(String message) Assert level logging
void	assrt(String template, Object... args) Assert level logging in a parameterized string
void	debug(String message) Debug logging
void	debug(String template, Object... args) Debug level logging in a parameterized string
void	error(String message) Error level logging
void	error(String template, Object... args) Error level logging in a parameterized string
void	exception(Throwable e) Logs an exception
void	exception(Throwable e, String template, Object... args)
void	info(String message) Information level logging
void	info(String template, Object... args) Information level logging in a parameterized string
void	log(LogLevel logLevel, String message) Basic logging function with a single string message
void	log(LogLevel logLevel, String template, Object... args) Parameterized versions of the logging functions
void	setCurrentLogLevel(LogLevel logLevel) Sets the current logging level
void	setPackagePrefix() Sets the tag with the package name prefix
void	verbose(String message) Verbose logging
void	verbose(String template, Object... args) Verbose level logging in a parameterized string
void	warn(String message) Warning level logging
void	warn(String template, Object... args) Warning level logging in a parameterized string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM_OUT

public static final OutputChannel SYSTEM_OUT

OutputChannel implementation based on System.out. This can be useful in JUnit tests, since they run in an environment that lacks a working implementation of actual logging mechanism.

Constructor Detail

Log

public Log(@NonNull
           OutputChannel outputChannel)

Creates a new instance of the class using defaults

Parameters:

outputChannel - An interface to OutputChannel to uze for messages.

Log

public Log(@NonNull
           OutputChannel outputChannel,
           LogLevel currentLogLevel,
           @NonNull
           String tag)

Creates a new instance of the class

Parameters:

outputChannel - An interface to OutputChannel to uze for messages.

currentLogLevel - Current log level for logging

tag - Base tag to use for messages

Method Detail

setCurrentLogLevel

public void setCurrentLogLevel(LogLevel logLevel)

Sets the current logging level

Parameters:

logLevel - Log level to filter

setPackagePrefix

public void setPackagePrefix()

Sets the tag with the package name prefix

log

public void log(LogLevel logLevel,
                String message)

Basic logging function with a single string message

Parameters:

logLevel - Log level

message - Message to log

log

public void log(LogLevel logLevel,
                String template,
                Object... args)

Parameterized versions of the logging functions

Parameters:

logLevel - Log level

template - String template

args - Arguments

verbose

public void verbose(String message)

Verbose logging

Parameters:

message - Message to log

verbose

public void verbose(String template,
                    Object... args)

Verbose level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

debug

public void debug(String message)

Debug logging

Parameters:

message - Message to log

debug

public void debug(String template,
                  Object... args)

Debug level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

info

public void info(String message)

Information level logging

Parameters:

message - Message to log

info

public void info(String template,
                 Object... args)

Information level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

warn

public void warn(String message)

Warning level logging

Parameters:

message - Message to log

warn

public void warn(String template,
                 Object... args)

Warning level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

error

public void error(String message)

Error level logging

Parameters:

message - Message to log

error

public void error(String template,
                  Object... args)

Error level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

assrt

public void assrt(String message)

Assert level logging

Parameters:

message - Message to log

assrt

public void assrt(String template,
                  Object... args)

Assert level logging in a parameterized string

Parameters:

template - Parameterized string

args - Arguments

exception

public void exception(Throwable e)

Logs an exception

Parameters:

e - Exception to log

exception

public void exception(Throwable e,
                      String template,
                      Object... args)