Package com.github.chhorz.openapi.common.util

Class LogUtils

java.lang.Object

com.github.chhorz.openapi.common.util.LogUtils

public class LogUtils
extends Object

Internal logging utility class.

Author:

chhorz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEBUG
static final String	ERROR
static final String	INFO
static final String	OPENAPI_LOG_GROUP

Constructor Summary

Constructors

Constructor	Description
LogUtils(Messager messager, ParserProperties properties)	Creates a new LogUtils instance.
LogUtils(Messager messager, ParserProperties properties, String componentLogGroup)	Creates a new LogUtils instance.

Method Summary

Modifier and Type	Method	Description
LogUtils	configureWithComponent(String componentLogGroup)	Creates a cloned LogUtils class with the given component log group.
void	logDebug(String format, Object... arguments)	Prints the given log message if the log level is "DEBUG".
void	logError(String format, Exception exception, Object... arguments)	Prints the given log message.
void	logError(String format, Object... arguments)	Prints the given log message.
void	logInfo(String format, Object... arguments)	Prints the given log message if the log level is not "ERROR".

Methods inherited from class java.lang.Object

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

Field Details

OPENAPI_LOG_GROUP

public static final String OPENAPI_LOG_GROUP

See Also:

• Constant Field Values

DEBUG

public static final String DEBUG

See Also:

• Constant Field Values

INFO

public static final String INFO

See Also:

• Constant Field Values

ERROR

public static final String ERROR

See Also:

• Constant Field Values

Constructor Details

LogUtils

public LogUtils(Messager messager,
 ParserProperties properties)

Creates a new LogUtils instance.

Parameters:

messager - the messager from the ProcessingEnvironment

properties - the given parser properties that are required for the log level

LogUtils

public LogUtils(Messager messager,
 ParserProperties properties,
 String componentLogGroup)

Creates a new LogUtils instance.

Parameters:

messager - the messager from the ProcessingEnvironment

properties - the given parser properties that are required for the log level

componentLogGroup - a mandatory subgroup for the log statements

Method Details

configureWithComponent

public LogUtils configureWithComponent(String componentLogGroup)

Creates a cloned LogUtils class with the given component log group.

Parameters:

componentLogGroup - the subgroup for the log statements

Returns:

a new LogUtils class

logDebug

public void logDebug(String format,
 Object... arguments)

Prints the given log message if the log level is "DEBUG".

The parameters are related to String.format(String, Object...).

Parameters:

format - the format string

arguments - arguments for the format string

logInfo

public void logInfo(String format,
 Object... arguments)

Prints the given log message if the log level is not "ERROR".

The parameters are related to String.format(String, Object...).

Parameters:

format - the format string

arguments - arguments for the format string

logError

public void logError(String format,
 Object... arguments)

Prints the given log message.

The parameters are related to String.format(String, Object...).

Parameters:

format - the format string

arguments - arguments for the format string

logError

public void logError(String format,
 Exception exception,
 Object... arguments)

Prints the given log message.

The parameters are related to String.format(String, Object...).

Parameters:

format - the format string

exception - the current exception (will be logged via Throwable.printStackTrace())

arguments - arguments for the format string