org.jamplate.diagnostic

Interface Diagnostic

All Superinterfaces:

java.lang.Iterable<Message>, java.io.Serializable

All Known Implementing Classes:

DiagnosticImpl

public interface Diagnostic
extends java.lang.Iterable<Message>, java.io.Serializable

An interface to store and print notes, warnings and errors to the console.

Since:

0.2.0 ~2021.05.16

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
@NotNull Diagnostic	clear() Clear the message queue.
default @NotNull Diagnostic	flush() Flush the printed messages to the default print stream.
default @NotNull Diagnostic	flush(boolean debug) Flush the printed messages to the default print stream.
@NotNull Diagnostic	flush(boolean debug, java.io.PrintStream out, java.io.PrintStream err) Flush the printed messages to the default print stream.
default @NotNull Diagnostic	flush(java.io.PrintStream out, java.io.PrintStream err) Flush the printed messages to the default print stream.
@NotNull java.lang.String	format(boolean debug, @NotNull Message message) Format the given message.
default @NotNull java.lang.String	format(@NotNull Message message) Format the given message.
@NotNull Diagnostic	print(@NotNull Message message) Print the given message.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

flush

@NotNull
 @Contract(value="->this",
          mutates="this")
default @NotNull Diagnostic flush()

Flush the printed messages to the default print stream.

Returns:

this.

Since:

0.2.0 ~2021.05.31

flush

@NotNull
 @Contract(value="_->this",
          mutates="this")
default @NotNull Diagnostic flush(boolean debug)

Flush the printed messages to the default print stream.

Parameters:

debug - pass true to force debug mode.

Returns:

this.

Since:

0.2.0 ~2021.05.31

flush

@NotNull
 @Contract(value="_,_->this",
          mutates="this,param1,param2")
default @NotNull Diagnostic flush(java.io.PrintStream out,
                                                                                                                    java.io.PrintStream err)

Flush the printed messages to the default print stream.

Parameters:

out - the default output stream.

err - the error stream.

Returns:

this.

Since:

0.2.0 ~2021.05.31

format

@NotNull
 @Contract(value="_->new",
          pure=true)
default @NotNull java.lang.String format(@NotNull
                                                                                                     @NotNull Message message)

Format the given message.

Parameters:

message - the message to be formatted.

Returns:

a string representation of the given message in the style of this diagnostic system.

Throws:

java.lang.NullPointerException - if the given message is null.

Since:

0.2.0 ~2021.05.31

clear

@NotNull
 @Contract(value="->this",
          mutates="this")
@NotNull Diagnostic clear()

Clear the message queue.

Returns:

this.

Since:

0.2.0 ~2021.05.31

flush

@NotNull
 @Contract(value="_,_,_->this",
          mutates="this,param2,param3")
@NotNull Diagnostic flush(boolean debug,
                                                                                                              java.io.PrintStream out,
                                                                                                              java.io.PrintStream err)

Flush the printed messages to the default print stream.

Parameters:

debug - pass true to force debug mode.

out - the default output stream.

err - the error stream.

Returns:

this.

Since:

0.2.0 ~2021.05.31

format

@NotNull
 @Contract(value="_,_->new",
          pure=true)
@NotNull java.lang.String format(boolean debug,
                                                                                               @NotNull
                                                                                               @NotNull Message message)

Format the given message.

Parameters:

debug - pass ture to force debug mode.

message - the message to be formatted.

Returns:

a string representation of the given message in the style of this diagnostic system.

Throws:

java.lang.NullPointerException - if the given message is null.

Since:

0.2.0 ~2021.05.31

print

@NotNull
 @Contract(value="_->this",
          mutates="this")
@NotNull Diagnostic print(@NotNull
                                                                                            @NotNull Message message)

Print the given message.

Parameters:

message - the message to be printed.

Returns:

this.

Throws:

java.lang.NullPointerException - if the given message is null.

Since:

0.2.0 ~2021.05.31