de.unkrig.commons.util.logging

Class LogUtil

java.lang.Object

de.unkrig.commons.util.logging.LogUtil

public final class LogUtil
extends Object

Various java.util.logging-related utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static Level	INFO_PLUS_1 A Level one higher (towards Level.WARNING) than Level.INFO.
static Filter	LESS_THAN_CONFIG Regards levels less than Level.CONFIG (e.g.
static Filter	LESS_THAN_INFO Regards levels less than Level.INFO (e.g.
static Filter	LESS_THAN_WARNING Regards levels less than Level.WARNING (e.g.
static LogManager	LOG_MANAGER An alternative to repeated calls to LogManager.getLogManager().
static Logger	ROOT_LOGGER Is Logger.getLogger("").
static Level	WARNING_PLUS_1 A Level one higher (towards Level.SEVERE) than Level.WARNING.

Method Summary

Modifier and Type	Method and Description
static String	getLoggingProperty(String propertyName)
static Boolean	getLoggingProperty(String propertyName, Boolean defaulT)
static <T> T	getLoggingProperty(String propertyName, Class<T> type) Evaluates the value of the named property to an object of the given type and returns it.
static <T> T	getLoggingProperty(String propertyName, Class<T> type, T defaulT) Evaluates the value of the named property to an object of the given type and returns it.
static Level	getLoggingProperty(String propertyName, Level defaulT)
static long	getLoggingProperty(String propertyName, Long defaulT)
static String	getLoggingProperty(String propertyName, String defaulT)
static Filter	levelLimitFilter(Level upperBound)
static Consumer<String>	logConsumer(Logger logger, Level level, String prefix) Strings passed to the returned Consumer are logged to the given logger at the given level.
static Writer	logWriter(Logger logger, Level level, String prefix) Lines written to the returned Writer are optionally prepended with the given prefix, and then logged to the given Logger at the given Level.
static Expression	parseLoggingProperty(String propertyName, String... validVariableNames) Parses an expression from the value of the named logging property.
static String	requireLoggingProperty(String propertyName)
static <T> T	requireLoggingProperty(String propertyName, Class<T> type) Evaluates the value of the named property to an object of the given type and returns it.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_MANAGER

public static final LogManager LOG_MANAGER

An alternative to repeated calls to LogManager.getLogManager().

ROOT_LOGGER

public static final Logger ROOT_LOGGER

Is Logger.getLogger("").

WARNING_PLUS_1

public static final Level WARNING_PLUS_1

A Level one higher (towards Level.SEVERE) than Level.WARNING.

INFO_PLUS_1

public static final Level INFO_PLUS_1

A Level one higher (towards Level.WARNING) than Level.INFO.

LESS_THAN_WARNING

public static final Filter LESS_THAN_WARNING

Regards levels less than Level.WARNING (e.g. INFO, CONFIG, FINE, FINER, FINEST) as loggable.

LESS_THAN_INFO

public static final Filter LESS_THAN_INFO

Regards levels less than Level.INFO (e.g. CONFIG, FINE, FINER, FINEST) as loggable.

LESS_THAN_CONFIG

public static final Filter LESS_THAN_CONFIG

Regards levels less than Level.CONFIG (e.g. FINE, FINER, FINEST) as loggable.

Method Detail

logConsumer

public static Consumer<String> logConsumer(Logger logger,
                                           Level level,
                                           @Nullable
                                           String prefix)

Strings passed to the returned Consumer are logged to the given logger at the given level.

Parameters:

prefix - Is prepended to each string before it is logged

logWriter

public static Writer logWriter(Logger logger,
                               Level level,
                               @Nullable
                               String prefix)

Lines written to the returned Writer are optionally prepended with the given prefix, and then logged to the given Logger at the given Level.

levelLimitFilter

public static Filter levelLimitFilter(Level upperBound)

Returns:

A Filter that regards levels lower than upperBound as loggable

getLoggingProperty

@Nullable
public static String getLoggingProperty(String propertyName)

Returns:

The value of the named logging property, or the null

getLoggingProperty

public static Boolean getLoggingProperty(String propertyName,
                                         Boolean defaulT)

Returns:

The boolean value of the named logging property, or the defaulT

getLoggingProperty

@Nullable
public static <T> T getLoggingProperty(String propertyName,
                                                  Class<T> type)
                                           throws ParseException,
                                                  EvaluationException

Evaluates the value of the named property to an object of the given type and returns it.

Returns:

null if the logging property is not defined, or if the expression evaluates to null

Throws:

EvaluationException - The value of the property is not assignable to T

ParseException

getLoggingProperty

public static <T> T getLoggingProperty(String propertyName,
                                       Class<T> type,
                                       T defaulT)
                                throws ParseException,
                                       EvaluationException

Evaluates the value of the named property to an object of the given type and returns it.

Returns:

defaulT if the property is not set, or evaluates to null

Throws:

ParseException

EvaluationException

See Also:

The expression syntax of the property value

requireLoggingProperty

public static <T> T requireLoggingProperty(String propertyName,
                                           Class<T> type)
                                    throws ParseException,
                                           EvaluationException

Evaluates the value of the named property to an object of the given type and returns it.

Throws:

IllegalArgumentException - The logging property is not defined

EvaluationException - The property evaluates to null

EvaluationException - The value of the property is not assignable to T

ParseException

getLoggingProperty

public static Level getLoggingProperty(String propertyName,
                                       Level defaulT)

Returns:

The level value of the named logging property, or the given defaulT

Throws:

IllegalArgumentException - The value could not be parsed to a valid level

getLoggingProperty

public static long getLoggingProperty(String propertyName,
                                      Long defaulT)

Returns:

The value of the named logging property, converted to LONG, or the defaulT

Throws:

IllegalArgumentException - The property text cannot be parsed into a LONG

getLoggingProperty

public static String getLoggingProperty(String propertyName,
                                        String defaulT)

Returns:

The value of the named logging property, or the defaulT

requireLoggingProperty

public static String requireLoggingProperty(String propertyName)

Returns:

The value of the named logging property

Throws:

IllegalArgumentException - The named logging property is not defined

parseLoggingProperty

public static Expression parseLoggingProperty(String propertyName,
                                              String... validVariableNames)
                                       throws ParseException

Parses an expression from the value of the named logging property.

Throws:

IllegalArgumentException - The named logging property is not defined

ParseException