Crossfire JXClient, Trunk
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
com.realtime.crossfire.jxclient.window.Logger Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.window.Logger:
Collaboration graph

Public Member Functions

 Logger (@NotNull final CrossfireServerConnection crossfireServerConnection, @Nullable final String hostname, final boolean enabled)
 
void setHostname (@Nullable final String hostname)
 

Private Member Functions

void log (@NotNull final String message)
 

Private Attributes

final CrossfireDrawextinfoListener crossfireDrawextinfoListener
 
final boolean enabled
 
String hostname
 

Static Private Attributes

static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss ", Locale.ENGLISH)
 

Detailed Description

Logs received messages to a file.

Author
Andreas Kirschbaum

Definition at line 43 of file Logger.java.

Constructor & Destructor Documentation

◆ Logger()

com.realtime.crossfire.jxclient.window.Logger.Logger ( @NotNull final CrossfireServerConnection  crossfireServerConnection,
@Nullable final String  hostname,
final boolean  enabled 
)

Create a new instance.

Parameters
crossfireServerConnectionthe server connection to monitor
hostnamethe hostname
enabledwhether the message logger is enabled

Definition at line 88 of file Logger.java.

References com.realtime.crossfire.jxclient.window.Logger.crossfireDrawextinfoListener, com.realtime.crossfire.jxclient.window.Logger.enabled, com.realtime.crossfire.jxclient.window.Logger.hostname, and com.realtime.crossfire.jxclient.window.Logger.log().

Here is the call graph for this function:

Member Function Documentation

◆ log()

void com.realtime.crossfire.jxclient.window.Logger.log ( @NotNull final String  message)
private

Adds a message to the log file.

Parameters
messagethe message

Definition at line 108 of file Logger.java.

References com.realtime.crossfire.jxclient.window.Logger.enabled, com.realtime.crossfire.jxclient.window.Logger.FORMATTER, com.realtime.crossfire.jxclient.settings.Filenames.getMessageLogFile(), and com.realtime.crossfire.jxclient.window.Logger.hostname.

Referenced by com.realtime.crossfire.jxclient.window.Logger.Logger().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setHostname()

void com.realtime.crossfire.jxclient.window.Logger.setHostname ( @Nullable final String  hostname)

Updates the hostname.

Parameters
hostnamethe new hostname

Definition at line 100 of file Logger.java.

References com.realtime.crossfire.jxclient.window.Logger.hostname.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

Here is the caller graph for this function:

Member Data Documentation

◆ crossfireDrawextinfoListener

final CrossfireDrawextinfoListener com.realtime.crossfire.jxclient.window.Logger.crossfireDrawextinfoListener
private
Initial value:
= new CrossfireDrawextinfoListener() {
@Override
public void commandDrawextinfoReceived(final int color, final int type, final int subtype, @NotNull final String message) {
log(message);
}
@Override
public void setDebugMode(final boolean printMessageTypes) {
}
}

The CrossfireDrawextinfoListener registered to receive drawextinfo commands.

Definition at line 68 of file Logger.java.

Referenced by com.realtime.crossfire.jxclient.window.Logger.Logger().

◆ enabled

final boolean com.realtime.crossfire.jxclient.window.Logger.enabled
private

Whether the message logger is enabled.

Definition at line 60 of file Logger.java.

Referenced by com.realtime.crossfire.jxclient.window.Logger.log(), and com.realtime.crossfire.jxclient.window.Logger.Logger().

◆ FORMATTER

final DateTimeFormatter com.realtime.crossfire.jxclient.window.Logger.FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss ", Locale.ENGLISH)
staticprivate

The format for writing timestamps.

Definition at line 49 of file Logger.java.

Referenced by com.realtime.crossfire.jxclient.window.Logger.log().

◆ hostname

String com.realtime.crossfire.jxclient.window.Logger.hostname
private

The documentation for this class was generated from the following file:
com.realtime.crossfire.jxclient.window.Logger.log
void log(@NotNull final String message)
Definition: Logger.java:108