Package com.piketec.tpt.api

Class Log

java.lang.Object

com.piketec.tpt.api.Log

All Implemented Interfaces:

java.io.Serializable

public class Log
extends java.lang.Object
implements java.io.Serializable

A Log is a list of messages where each messages has a Log.LogType.

Author:

Copyright (c) 2014-2020 Piketec GmbH - MIT License (MIT) - All rights reserved

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Log.LogEntry	A log message and its Log.LogType.
static class	Log.LogType	The log type or severity of a log message.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Log.LogEntry>	entries
protected int	errorCount
protected int	infoCount
protected int	warningCount

Constructor Summary

Constructors

Constructor	Description
Log()

Method Summary

Modifier and Type	Method	Description
void	addError(java.lang.String message)	Adds a new log entry with Log.LogType.ERROR
void	addInfo(java.lang.String message)	Adds a new log entry with Log.LogType.INFO
void	addWarning(java.lang.String message)	Adds a new log entry with Log.LogType.WARNING
java.util.List<Log.LogEntry>	getEntries()
int	getErrorCount()
int	getInfoCount()
int	getWarningCount()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

entries

protected java.util.List<Log.LogEntry> entries

errorCount

protected int errorCount

warningCount

protected int warningCount

infoCount

protected int infoCount

Constructor Detail

Log

public Log()

Method Detail

addError

public void addError(java.lang.String message)

Adds a new log entry with Log.LogType.ERROR

Parameters:

message - The message text

getErrorCount

public int getErrorCount()

Returns:

The amout of error messages contained in this log.

addWarning

public void addWarning(java.lang.String message)

Adds a new log entry with Log.LogType.WARNING

Parameters:

message - The message text

getWarningCount

public int getWarningCount()

Returns:

The amout of warning messages contained in this log.

addInfo

public void addInfo(java.lang.String message)

Adds a new log entry with Log.LogType.INFO

Parameters:

message - The message text

getInfoCount

public int getInfoCount()

Returns:

The amout of info messages contained in this log.

getEntries

public java.util.List<Log.LogEntry> getEntries()

Returns:

all log entries of all LogTypes of this log as an unmodifiable list.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object