de.unkrig.commons.text

Interface Printer

All Known Implementing Classes:

AbstractPrinter, LevelFilteredPrinter, StreamPrinter, WriterPrinter

public interface Printer

A very generic interface for applications to "print messages".

Like the various logging mechanisms, the underlying concept is to define several "levels" of logging, and process messages of different levels differently. Unlike logging, printing is not JVM-global, but applies only to specific contexts. In other words, it is not possible to "set" a global printer, but only to run runnables "in the context" of a printer (see Printers.withPrinter(Printer, Runnable)). This is useful e.g. in multi-threaded environments like tasks in a build system or a script.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String message) Prints a debug message.
void	debug(java.lang.String pattern, java.lang.Object... arguments) Prints a debug message.
void	error(java.lang.String message) Prints an error condition.
void	error(java.lang.String pattern, java.lang.Object... arguments) Prints an error condition.
void	error(java.lang.String message, java.lang.Throwable t) Prints an error condition.
void	error(java.lang.String pattern, java.lang.Throwable t, java.lang.Object... arguments) Prints an error condition.
void	info(java.lang.String message) Prints an informative ("normal") message.
void	info(java.lang.String pattern, java.lang.Object... arguments) Prints an informative ("normal") message.
boolean	isDebugEnabled()
boolean	isInfoEnabled()
boolean	isVerboseEnabled()
boolean	isWarnEnabled()
void	verbose(java.lang.String message) Prints a verbose message.
void	verbose(java.lang.String pattern, java.lang.Object... arguments) Prints a verbose message.
void	warn(java.lang.String message) Prints a warning condition.
void	warn(java.lang.String pattern, java.lang.Object... arguments) Prints a warning condition.

Method Detail

error

void error(@Nullable
           java.lang.String message)

Prints an error condition.

error

void error(java.lang.String pattern,
           java.lang.Object... arguments)

Prints an error condition.

See Also:

Format.format(Object)

error

void error(java.lang.String message,
           @Nullable
           java.lang.Throwable t)

Prints an error condition.

error

void error(java.lang.String pattern,
           @Nullable
           java.lang.Throwable t,
           java.lang.Object... arguments)

Prints an error condition.

See Also:

Format.format(Object)

isWarnEnabled

boolean isWarnEnabled()

Returns:

Whether the warn(String) methods have any effect

warn

void warn(@Nullable
          java.lang.String message)

Prints a warning condition.

warn

void warn(java.lang.String pattern,
          java.lang.Object... arguments)

Prints a warning condition.

See Also:

Format.format(Object)

isInfoEnabled

boolean isInfoEnabled()

Returns:

Whether the info(String) methods have any effect

info

void info(@Nullable
          java.lang.String message)

Prints an informative ("normal") message.

info

void info(java.lang.String pattern,
          java.lang.Object... arguments)

Prints an informative ("normal") message.

See Also:

Format.format(Object)

isVerboseEnabled

boolean isVerboseEnabled()

Returns:

Whether the verbose(String) methods have any effect

verbose

void verbose(@Nullable
             java.lang.String message)

Prints a verbose message.

verbose

void verbose(java.lang.String pattern,
             java.lang.Object... arguments)

Prints a verbose message.

See Also:

Format.format(Object)

isDebugEnabled

boolean isDebugEnabled()

Returns:

Whether the debug(String) methods have any effect

debug

void debug(@Nullable
           java.lang.String message)

Prints a debug message.

debug

void debug(java.lang.String pattern,
           java.lang.Object... arguments)

Prints a debug message.

See Also:

Format.format(Object)