Class LoggingUtils
- java.lang.Object
-
- org.apache.sshd.common.util.logging.LoggingUtils
-
public final class LoggingUtils extends java.lang.Object
-
-
Constructor Summary
Constructors Modifier Constructor Description private
LoggingUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <T> java.util.function.Consumer<T>
debugClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
debugClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
static <T> java.util.function.Consumer<T>
errorClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
errorClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
static java.util.NavigableMap<java.lang.Integer,java.lang.String>
generateMnemonicMap(java.lang.Class<?> clazz, java.lang.String commonPrefix)
Scans using reflection API for all fields that arepublic static final
that start with the given common prefix (case sensitive) and are of typeNumber
.static java.util.NavigableMap<java.lang.Integer,java.lang.String>
generateMnemonicMap(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate.static java.util.Map<java.lang.String,java.lang.Integer>
getAmbiguousMenmonics(java.lang.Class<?> clazz, java.lang.String commonPrefix)
Scans using reflection API for all numericpublic static final
fields that have a common prefix and whose value is used by several of the other matching fieldsstatic java.util.Map<java.lang.String,java.lang.Integer>
getAmbiguousMenmonics(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate and whose value is used by several of the other matching fieldsstatic java.util.Collection<java.lang.reflect.Field>
getMnemonicFields(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate.static <T> java.util.function.Consumer<T>
infoClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
infoClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
static boolean
isLoggable(java.util.logging.Level level, java.util.logging.Level threshold)
Verifies if the given level is above the required threshold for logging.static boolean
isLoggable(org.slf4j.Logger logger, java.util.logging.Level level)
static <T> java.util.function.Consumer<T>
loggingClosure(org.slf4j.Logger logger, java.util.logging.Level level)
static <T> java.util.function.Consumer<T>
loggingClosure(org.slf4j.Logger logger, java.util.logging.Level level, java.lang.Throwable t)
static void
logMessage(org.slf4j.Logger logger, java.util.logging.Level level, java.lang.Object message, java.lang.Throwable t)
static <T> java.util.function.Consumer<T>
nologClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
traceClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
traceClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
static <T> java.util.function.Consumer<T>
warnClosure(org.slf4j.Logger logger)
static <T> java.util.function.Consumer<T>
warnClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
static SimplifiedLog
wrap(org.slf4j.Logger logger)
-
-
-
Method Detail
-
generateMnemonicMap
public static java.util.NavigableMap<java.lang.Integer,java.lang.String> generateMnemonicMap(java.lang.Class<?> clazz, java.lang.String commonPrefix)
Scans using reflection API for all fields that arepublic static final
that start with the given common prefix (case sensitive) and are of typeNumber
.- Parameters:
clazz
- TheClass
to querycommonPrefix
- The expected common prefix- Returns:
- A
NavigableMap
of all the matching fields, where key=the field'sInteger
value and mapping=the field's name - See Also:
generateMnemonicMap(Class, Predicate)
-
generateMnemonicMap
public static java.util.NavigableMap<java.lang.Integer,java.lang.String> generateMnemonicMap(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate. Any field that is not such or fail to retrieve its value, or has a duplicate value is silently skipped.- Parameters:
clazz
- TheClass
to queryacceptor
- ThePredicate
used to decide whether to process theField
(besides being aNumber
andpublic static final
).- Returns:
- A
NavigableMap
of all the matching fields, where key=the field'sInteger
value and mapping=the field's name - See Also:
getMnemonicFields(Class, Predicate)
-
getAmbiguousMenmonics
public static java.util.Map<java.lang.String,java.lang.Integer> getAmbiguousMenmonics(java.lang.Class<?> clazz, java.lang.String commonPrefix)
Scans using reflection API for all numericpublic static final
fields that have a common prefix and whose value is used by several of the other matching fields- Parameters:
clazz
- TheClass
to querycommonPrefix
- The expected common prefix- Returns:
- A
Map
of all the mnemonic fields names whose value is the same as other fields in this map. The key is the field's name and value is its associated opcode. - See Also:
getAmbiguousMenmonics(Class, Predicate)
-
getAmbiguousMenmonics
public static java.util.Map<java.lang.String,java.lang.Integer> getAmbiguousMenmonics(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate and whose value is used by several of the other matching fields- Parameters:
clazz
- TheClass
to queryacceptor
- ThePredicate
used to decide whether to process theField
(besides being aNumber
andpublic static final
).- Returns:
- A
Map
of all the mnemonic fields names whose value is the same as other fields in this map. The key is the field's name and value is its associated opcode. - See Also:
getMnemonicFields(Class, Predicate)
-
getMnemonicFields
public static java.util.Collection<java.lang.reflect.Field> getMnemonicFields(java.lang.Class<?> clazz, java.util.function.Predicate<? super java.lang.reflect.Field> acceptor)
Scans using reflection API for all numericpublic static final
fields that are also accepted by the predicate.- Parameters:
clazz
- TheClass
to queryacceptor
- ThePredicate
used to decide whether to process theField
(besides being aNumber
andpublic static final
).- Returns:
- A
Collection
of all the fields that have satisfied all conditions
-
isLoggable
public static boolean isLoggable(java.util.logging.Level level, java.util.logging.Level threshold)
Verifies if the given level is above the required threshold for logging.- Parameters:
level
- TheLevel
to evaluatethreshold
- The thresholdLevel
- Returns:
true
if the evaluated level is above the required threshold.Note(s):
If either argument is
null
then result isfalse
.If the evaluated level is
Level.OFF
then result isfalse
regardless of the threshold.If the threshold is
Level.ALL
and the evaluated level is notLevel.OFF
the result istrue
.Otherwise, the evaluated level
Level.intValue()
must be greater or equal to the threshold.
-
wrap
public static SimplifiedLog wrap(org.slf4j.Logger logger)
-
logMessage
public static void logMessage(org.slf4j.Logger logger, java.util.logging.Level level, java.lang.Object message, java.lang.Throwable t)
-
isLoggable
public static boolean isLoggable(org.slf4j.Logger logger, java.util.logging.Level level)
- Parameters:
logger
- TheLogger
instance - ignored ifnull
level
- The validate logLevel
- ignored ifnull
- Returns:
true
if the level is enabled for the logger. The mapping of the level to the logger is as follows:Level.OFF
always returnsfalse
Level.SEVERE
returnsLogger.isErrorEnabled()
Level.WARNING
returnsLogger.isWarnEnabled()
Level.INFO
andLevel.ALL
returnsLogger.isInfoEnabled()
Level.CONFIG
andLevel.FINE
returnsLogger.isDebugEnabled()
- All other levels return
Logger.isTraceEnabled()
-
loggingClosure
public static <T> java.util.function.Consumer<T> loggingClosure(org.slf4j.Logger logger, java.util.logging.Level level)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to uselevel
- The logLevel
mapped as follows:Level.OFF
-nologClosure(Logger)
Level.SEVERE
-errorClosure(Logger)
Level.WARNING
-warnClosure(Logger)
Level.INFO
/Level.ALL
-infoClosure(Logger)
Level.CONFIG
/Level.FINE
-debugClosure(Logger)
- All others -
traceClosure(Logger)
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument if the specific level is enabled
-
loggingClosure
public static <T> java.util.function.Consumer<T> loggingClosure(org.slf4j.Logger logger, java.util.logging.Level level, java.lang.Throwable t)
-
nologClosure
public static <T> java.util.function.Consumer<T> nologClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs nothing when invoked
-
errorClosure
public static <T> java.util.function.Consumer<T> errorClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isErrorEnabled()
-
errorClosure
public static <T> java.util.function.Consumer<T> errorClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to usethrown
- AThrowable
to attach to the message - ignored ifnull
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isErrorEnabled()
-
warnClosure
public static <T> java.util.function.Consumer<T> warnClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isWarnEnabled()
-
warnClosure
public static <T> java.util.function.Consumer<T> warnClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to usethrown
- AThrowable
to attach to the message - ignored ifnull
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isWarnEnabled()
-
infoClosure
public static <T> java.util.function.Consumer<T> infoClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isInfoEnabled()
-
infoClosure
public static <T> java.util.function.Consumer<T> infoClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to usethrown
- AThrowable
to attach to the message - ignored ifnull
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isInfoEnabled()
-
debugClosure
public static <T> java.util.function.Consumer<T> debugClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isDebugEnabled()
-
debugClosure
public static <T> java.util.function.Consumer<T> debugClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to usethrown
- AThrowable
to attach to the message - ignored ifnull
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isDebugEnabled()
-
traceClosure
public static <T> java.util.function.Consumer<T> traceClosure(org.slf4j.Logger logger)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to use- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isTraceEnabled()
-
traceClosure
public static <T> java.util.function.Consumer<T> traceClosure(org.slf4j.Logger logger, java.lang.Throwable thrown)
- Type Parameters:
T
- Generic message type consumer- Parameters:
logger
- TheLogger
instance to usethrown
- AThrowable
to attach to the message - ignored ifnull
- Returns:
- A consumer whose
Consumer.accept(Object)
method logs theString.valueOf(Object)
value of its argument ifLogger.isTraceEnabled()
-
-