Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.lang

Class DebugOutput

java.lang.Object

org.tquadrat.foundation.lang.DebugOutput

@UtilityClass
@ClassVersion(sourceVersion="$Id: DebugOutput.java 1084 2024-01-03 15:31:20Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class DebugOutput
extends Object

Some functions for DEBUG and TEST output to the console.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DebugOutput.java 1084 2024-01-03 15:31:20Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.lang.DebugOutput"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	m_IsDebug	The DEBUG flag.
private static final boolean	m_IsTest	The TEST flag.
private static Printer	m_Printer	The printer.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DebugOutput()	No instance is allowed for this class!

Method Summary

Modifier and Type	Method	Description
static final Optional<StackTraceElement>	findCaller(String methodName, Class<?> owningClass)	This method will find the caller for the method that is identified by its name and class, and returns the appropriate stack trace element.
static final void	ifDebug(boolean condition, Function<Object[],String> supplier, Object... args)	If the System property "isDebug" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write the result.
static final void	ifDebug(String message, Object... args)	If the System property "isDebug" is set, call the specified Printer to write the given message.
static final void	ifDebug(Throwable e)	If the System property "isDebug" is set, a call to e.printStackTrace() is made.
static final void	ifDebug(BooleanSupplier condition, Function<Object[],String> supplier, Object... args)	If the System property "isDebug" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write result.
static final void	ifDebug(Function<Object[],String> supplier, Object... args)	If the System property "isDebug" is set, call the specified Printer to write the given message.
static final void	ifTest(boolean condition, Function<Object[],String> supplier, Object... args)	If the System property "isTest" is set and the given condition resolves to true, execute the given Supplier and call the specified Printer to write the result.
static final void	ifTest(String message, Object... args)	If the System property "isTest" is set, call the specified Printer to write the given message.
static final void	ifTest(Throwable e)	If the System property "isTest" is set, a call to e.printStackTrace() is made.
static final void	ifTest(BooleanSupplier condition, Function<Object[],String> supplier, Object... args)	If the System property "isTest" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write the result.
static final void	ifTest(Function<Object[],String> supplier, Object... args)	If the System property "isTest" is set, execute the given Function and call the specified Printer to write the result.
static final boolean	isDebug()	Returns the DEBUG flag.
static final boolean	isTest()	Returns the TEST flag.
static final void	setPrinter(Printer printer)	Assigns the Printer for the DEBUG/TEST output.

Methods inherited from class java.lang.Object

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

Field Details

m_Printer

private static Printer m_Printer

The printer.

m_IsDebug

private static final boolean m_IsDebug

The DEBUG flag.

See Also:

• CommonConstants.PROPERTY_IS_DEBUG

m_IsTest

private static final boolean m_IsTest

The TEST flag.

See Also:

• CommonConstants.PROPERTY_IS_TEST

Constructor Details

DebugOutput

private DebugOutput()

No instance is allowed for this class!

Method Details

findCaller

@API(status=STABLE,
     since="0.1.0")
public static final Optional<StackTraceElement> findCaller(String methodName,
 Class<?> owningClass)

This method will find the caller for the method that is identified by its name and class, and returns the appropriate stack trace element.

The return value is empty when the provided method is not on the stack trace.

Parameters:

methodName - The name of the method that we need the caller for.

owningClass - The class for the called method.

Returns:

An instance of Optional that holds the stack trace element for the caller.

ifDebug

@API(status=STABLE,
     since="0.1.0")
public static final void ifDebug(String message,
 Object... args)

If the System property "isDebug" is set, call the specified Printer to write the given message.

Parameters:

message - The message; it is a format as defined for Formatter.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifDebug

@API(status=STABLE,
     since="0.1.0")
public static final void ifDebug(Function<Object[],String> supplier,
 Object... args)

If the System property "isDebug" is set, call the specified Printer to write the given message.

Parameters:

supplier - The Function for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifDebug

@API(status=STABLE,
     since="0.1.0")
public static final void ifDebug(BooleanSupplier condition,
 Function<Object[],String> supplier,
 Object... args)

If the System property "isDebug" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write result.

Parameters:

condition - Only if true, there will be an output.

supplier - The Supplier for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifDebug

@API(status=STABLE,
     since="0.1.0")
public static final void ifDebug(boolean condition,
 Function<Object[],String> supplier,
 Object... args)

If the System property "isDebug" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write the result.

Parameters:

condition - Only if true, there will be an output.

supplier - The Supplier for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifDebug

@API(status=STABLE,
     since="0.1.0")
public static final void ifDebug(Throwable e)

If the System property "isDebug" is set, a call to e.printStackTrace() is made.

Use this to provide a view to an otherwise ignored exception.

Parameters:

e - The exception.

See Also:

• setPrinter(Printer)

ifTest

@API(status=STABLE,
     since="0.1.0")
public static final void ifTest(String message,
 Object... args)

If the System property "isTest" is set, call the specified Printer to write the given message.

Parameters:

message - The message; it is a format as defined for Formatter.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifTest

@API(status=STABLE,
     since="0.1.0")
public static final void ifTest(Function<Object[],String> supplier,
 Object... args)

If the System property "isTest" is set, execute the given Function and call the specified Printer to write the result.

Parameters:

supplier - The Supplier for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifTest

@API(status=STABLE,
     since="0.1.0")
public static final void ifTest(BooleanSupplier condition,
 Function<Object[],String> supplier,
 Object... args)

If the System property "isTest" is set and the given condition resolves to true, execute the given Function and call the specified Printer to write the result.

Parameters:

condition - Only if true, there will be an output.

supplier - The Supplier for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifTest

@API(status=STABLE,
     since="0.1.0")
public static final void ifTest(boolean condition,
 Function<Object[],String> supplier,
 Object... args)

If the System property "isTest" is set and the given condition resolves to true, execute the given Supplier and call the specified Printer to write the result.

Parameters:

condition - Only if true, there will be an output.

supplier - The Supplier for the output.

args - Optional argument for the supplier.

See Also:

• setPrinter(Printer)

ifTest

@API(status=STABLE,
     since="0.1.0")
public static final void ifTest(Throwable e)

If the System property "isTest" is set, a call to e.printStackTrace() is made.

Use this to get a view to an otherwise ignored exception.

Parameters:

e - The exception.

See Also:

• setPrinter(Printer)

isDebug

public static final boolean isDebug()

Returns the DEBUG flag.

Returns:

true if the DEBUG flag is set, false otherwise.

See Also:

• CommonConstants.PROPERTY_IS_DEBUG

isTest

public static final boolean isTest()

Returns the TEST flag.

Returns:

true if the TEST flag is set, false otherwise.

See Also:

• CommonConstants.PROPERTY_IS_TEST

setPrinter

public static final void setPrinter(Printer printer)

Assigns the Printer for the DEBUG/TEST output.

The default implementation writes to System.out.

Parameters:

printer - The printer