blasd.apex.core.logging

Class ApexLogHelper

java.lang.Object

blasd.apex.core.logging.ApexLogHelper

public class ApexLogHelper
extends Object

Various helpers for logging

Author:

Benoit Lacelle

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BARRIER_FOR_SIZE_IN_LOG We want to see at least 2 digits: after printing 9999B, we print 10KB
static int	TEN_F
static int	THOUSAND

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApexLogHelper()

Method Summary

Modifier and Type	Method and Description
static Object	escapeNewLines(Object toString)
static Object	getFirstChars(Object toString, int limitChars)
static Object	getNiceDouble(Double value)
static Object	getNiceMemory(long size)
static Object	getNicePercentage(long progress, long max)
static Object	getNiceRate(long nbEntries, long time, TimeUnit timeUnit)
static Object	getNiceTime(long timeInMs)
static Object	getNiceTime(long time, TimeUnit timeUnit)
static Object	getObjectAndClass(Object o)
static Object	getSingleRow(Object toString, boolean removeEOL) Deprecated. Prefer .removeNewLines or .escapeNewLines
static Object	getToStringWithLimit(Iterable<?> iterable, int limitSize) Deprecated. prefer .getFirstChars
static Object	lazyToString(Supplier<String> toStringMe) This methods facilitates using logging framework at trace level, without using .isTraceEnabled, as the .toString
static Object	removeNewLines(Object toString)

Methods inherited from class java.lang.Object

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

Field Detail

BARRIER_FOR_SIZE_IN_LOG

protected static final int BARRIER_FOR_SIZE_IN_LOG

We want to see at least 2 digits: after printing 9999B, we print 10KB

See Also:

Constant Field Values

THOUSAND

public static final int THOUSAND

See Also:

Constant Field Values

TEN_F

public static final int TEN_F

See Also:

Constant Field Values

Constructor Detail

ApexLogHelper

protected ApexLogHelper()

Method Detail

lazyToString

public static Object lazyToString(Supplier<String> toStringMe)

This methods facilitates using logging framework at trace level, without using .isTraceEnabled, as the .toString

Parameters:

toStringMe - the object from which a .toString should be computed lazily

Returns:

an Object which has as .toString the one provided by the Supplier

getNicePercentage

public static Object getNicePercentage(long progress,
                                       long max)

getNiceMemory

public static Object getNiceMemory(long size)

getObjectAndClass

public static Object getObjectAndClass(Object o)

getToStringWithLimit

@Deprecated
public static Object getToStringWithLimit(Iterable<?> iterable,
                                                      int limitSize)

Deprecated. prefer .getFirstChars

getNiceDouble

public static Object getNiceDouble(Double value)

getNiceTime

public static Object getNiceTime(long timeInMs)

getNiceTime

public static Object getNiceTime(long time,
                                 TimeUnit timeUnit)

getNiceRate

public static Object getNiceRate(long nbEntries,
                                 long time,
                                 TimeUnit timeUnit)

getFirstChars

public static Object getFirstChars(Object toString,
                                   int limitChars)

getSingleRow

@Deprecated
public static Object getSingleRow(Object toString,
                                              boolean removeEOL)

Deprecated. Prefer .removeNewLines or .escapeNewLines

Parameters:

toString -

removeEOL - if true, we replace end-of-line characters by a space, else we escape them

Returns:

a String which is guaranteed to hold on a single row

removeNewLines

public static Object removeNewLines(Object toString)

escapeNewLines

public static Object escapeNewLines(Object toString)