Package com.here.sdk.core.engine

Class LogControl

java.lang.Object

com.here.NativeBase

com.here.sdk.core.engine.LogControl

public final class LogControl
extends NativeBase

This class provides functionality to enable/disable console logs as well as setting a custom log appender to receive log messages from the HERE SDK. The severity hierarchy used by these APIs is described in LogLevel. Use LogAppender to further customize log handling at runtime after the configured HERE SDK threshold has been applied. Note, this class will load native libraries of the HERE SDK, therefore generally it should be used just before HERE SDK initialization, otherwise, it might have an unexpected performance impact if called not at the right time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LogControl.InvalidPathException	Invalid file path exception.

Method Summary

Modifier and Type	Method	Description
static void	disableLoggingToConsole()	Disables HERE SDK logging messages to console.
static void	enableLoggingToConsole(LogLevel level)	Enables HERE SDK logging messages to console that can be viewed using logcat tool.
static void	removeAppender()	Removes previously added custom log appender.
static void	setAppender(LogLevel level, LogAppender appender)	Sets a custom log appender to receive log messages from the HERE SDK.
static void	setAppender(LogLevel level, String path)	Sets a custom log appender that will write HERE SDK log messages to a file.

Methods inherited from class java.lang.Object

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

Method Details

enableLoggingToConsole

public static void enableLoggingToConsole(@NonNull
 LogLevel level)

Enables HERE SDK logging messages to console that can be viewed using logcat tool. Enabled by default with LogLevel.LOG_LEVEL_INFO.

Setting a LogLevel defines the minimal level of messages which will be reported, based on the following hierarchy:

1. LOG_LEVEL_INFO
2. LOG_LEVEL_WARNING
3. LOG_LEVEL_ERROR
4. LOG_LEVEL_FATAL

For example, when setting LOG_LEVEL_ERROR, then LOG_LEVEL_INFO and LOG_LEVEL_WARNING will be excluded from the logs. All other levels will be logged. Therefore, only one call is needed. Another call will overwrite the previous minimal level. See LogLevel for the severity hierarchy and threshold behavior used by all HERE SDK logging APIs. Use LogAppender if you need to apply additional runtime filtering after this threshold.

Parameters:

level -

Log level.

disableLoggingToConsole

public static void disableLoggingToConsole()

Disables HERE SDK logging messages to console. Enabled by default with LogLevel.LOG_LEVEL_INFO.

setAppender

public static void setAppender(@NonNull
 LogLevel level,
 @NonNull
 LogAppender appender)

Sets a custom log appender to receive log messages from the HERE SDK. This overwrites a previous custom log appender set by user. Note, that setting a custom appender does not disable logging to the console made by the HERE SDK, in order to do that use the disableLoggingToConsole() API. To receive log messages emitted during HERE SDK initialization, set the custom appender before creating the SDK engine. Setting it later still affects subsequent log messages. The passed level is the minimal threshold. The provided LogAppender can apply additional runtime filtering or routing after that threshold has been applied.

Parameters:

level -

Log level.

appender -

New log appender.

setAppender

public static void setAppender(@NonNull
 LogLevel level,
 @NonNull
 String path)
                        throws LogControl.InvalidPathException

Sets a custom log appender that will write HERE SDK log messages to a file. This overwrites a previous custom log appender set by user. Note, that setting a custom appender does not disable logging to the console made by the HERE SDK, in order to do that use the disableLoggingToConsole() API. To receive log messages emitted during HERE SDK initialization, set the file appender before creating the SDK engine. Setting it later still affects subsequent log messages.

Parameters:

level -

Log level.

path -

Absolute path to a file that the application has read/write permissions.

Throws:

LogControl.InvalidPathException -

LogControl.InvalidPathException Indicates that the file path is invalid or not writeable.

removeAppender

public static void removeAppender()

Removes previously added custom log appender.