Package fr.diskmth.loggy

Class Loggable

java.lang.Object

fr.diskmth.loggy.Loggable

Direct Known Subclasses:

Loggy, LoggyFile

public abstract class Loggable
extends Object

The Loggable class is an abstract class that provides basic logging functionality. It provides methods to get and set a formatter and mute the log output.

Since:

Loggy 1.4

Field Summary

Fields

Modifier and Type	Field	Description
protected LoggyFormatter	formatter
protected boolean	isMuted

Constructor Summary

Constructors

Constructor	Description
Loggable(LoggyFormatter formatter)	Creates a new Loggable object with the given formatter.

Method Summary

Modifier and Type	Method	Description
LoggyFormatter	getFormatter()	Gets the formatter used to format log messages.
boolean	isMuted()	Gets whether or not the log output is muted.
void	setFormatter(LoggyFormatter formatter)	Sets the formatter used to format log messages.
void	toggleMute()	Toggles whether or not the log output is muted.

Methods inherited from class java.lang.Object

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

Field Details

isMuted

protected boolean isMuted

formatter

protected LoggyFormatter formatter

Constructor Details

Loggable

public Loggable(LoggyFormatter formatter)

Creates a new Loggable object with the given formatter.

Parameters:

formatter - The formatter to use for formatting log messages.

Method Details

isMuted

public boolean isMuted()

Gets whether or not the log output is muted.

Returns:

True if the log output is muted, false otherwise.

getFormatter

public LoggyFormatter getFormatter()

Gets the formatter used to format log messages.

Returns:

The formatter used to format log messages.

toggleMute

public void toggleMute()

Toggles whether or not the log output is muted.

setFormatter

public void setFormatter(LoggyFormatter formatter)

Sets the formatter used to format log messages.

Parameters:

formatter - The formatter to use for formatting log messages.