org.jamplate.impl.diagnostic

Class DiagnosticImpl

java.lang.Object

org.jamplate.impl.diagnostic.DiagnosticImpl

All Implemented Interfaces:

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

public class DiagnosticImpl
extends java.lang.Object
implements Diagnostic

A basic implementation of the interface Diagnostic.

Since:

0.2.0 ~2021.05.19

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.util.Deque<Message>	queue The message queue.

Constructor Summary

Constructors

Constructor and Description
DiagnosticImpl()

Method Summary

Modifier and Type	Method and Description
@NotNull Diagnostic	clear() Clear the message queue.
@NotNull Diagnostic	flush(boolean debug, 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.
@NotNull java.util.Iterator<Message>	iterator()
@NotNull Diagnostic	print(@NotNull Message message) Print the given message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jamplate.diagnostic.Diagnostic

flush, flush, flush, format

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

queue

@NotNull
protected final @NotNull java.util.Deque<Message> queue

The message queue.

Since:

0.2.0 ~2021.05.31

Constructor Detail

DiagnosticImpl

public DiagnosticImpl()

Method Detail

clear

@NotNull
public @NotNull Diagnostic clear()

Description copied from interface: Diagnostic

Clear the message queue.

Specified by:

clear in interface Diagnostic

Returns:

this.

flush

@NotNull
public @NotNull Diagnostic flush(boolean debug,
                                           java.io.PrintStream out,
                                           java.io.PrintStream err)

Description copied from interface: Diagnostic

Flush the printed messages to the default print stream.

Specified by:

flush in interface Diagnostic

Parameters:

debug - pass true to force debug mode.

out - the default output stream.

err - the error stream.

Returns:

this.

format

@NotNull
public @NotNull java.lang.String format(boolean debug,
                                                  @NotNull
                                                  @NotNull Message message)

Description copied from interface: Diagnostic

Format the given message.

Specified by:

format in interface Diagnostic

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.

iterator

@NotNull
public @NotNull java.util.Iterator<Message> iterator()

Specified by:

iterator in interface java.lang.Iterable<Message>

print

@NotNull
public @NotNull Diagnostic print(@NotNull
                                           @NotNull Message message)

Description copied from interface: Diagnostic

Print the given message.

Specified by:

print in interface Diagnostic

Parameters:

message - the message to be printed.

Returns:

this.