Logs received messages to a file. More...

Collaboration diagram for com.realtime.crossfire.jxclient.window.Logger:

Public Member Functions
	Logger (@NotNull final CrossfireServerConnection crossfireServerConnection, @Nullable final String hostname, final boolean enabled)
	Create a new instance. More...

void	setHostname (@Nullable final String hostname)
	Updates the hostname. More...

Private Member Functions
void	log (@NotNull final String message)
	Adds a message to the log file. More...

Private Attributes
final CrossfireDrawextinfoListener	crossfireDrawextinfoListener
	The CrossfireDrawextinfoListener registered to receive drawextinfo commands. More...

final CrossfireDrawinfoListener	crossfireDrawinfoListener = (text, type) -> log(text)
	The CrossfireDrawinfoListener registered to receive drawinfo commands. More...

final CrossfireQueryListener	crossfireQueryListener = (prompt, queryType) -> log(prompt)
	The CrossfireQueryListener registered to receive query commands. More...

final boolean	enabled
	Whether the message logger is enabled. More...

final SimpleDateFormat	format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss ")
	The format for writing timestamps. More...

String	hostname
	The hostname. More...

Detailed Description

Logs received messages to a file.

Author: Andreas Kirschbaum

Definition at line 42 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

crossfireServerConnection	the server connection to monitor
hostname	the hostname
enabled	whether the message logger is enabled

Definition at line 102 of file Logger.java.

References com.realtime.crossfire.jxclient.window.Logger.crossfireDrawextinfoListener, com.realtime.crossfire.jxclient.window.Logger.crossfireDrawinfoListener, com.realtime.crossfire.jxclient.window.Logger.crossfireQueryListener, com.realtime.crossfire.jxclient.window.Logger.enabled, and com.realtime.crossfire.jxclient.window.Logger.hostname.

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

message the message

Definition at line 122 of file Logger.java.

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

Here is the call graph for this function:

◆ setHostname()

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

Updates the hostname.

Parameters

hostname the new hostname

Definition at line 114 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 74 of file Logger.java.

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

◆ crossfireDrawinfoListener

final CrossfireDrawinfoListener com.realtime.crossfire.jxclient.window.Logger.crossfireDrawinfoListener = (text, type) -> log(text)

private

The CrossfireDrawinfoListener registered to receive drawinfo commands.

Definition at line 94 of file Logger.java.

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

◆ crossfireQueryListener

final CrossfireQueryListener com.realtime.crossfire.jxclient.window.Logger.crossfireQueryListener = (prompt, queryType) -> log(prompt)

private

The CrossfireQueryListener registered to receive query commands.

Definition at line 66 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 59 of file Logger.java.

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

◆ format

final SimpleDateFormat com.realtime.crossfire.jxclient.window.Logger.format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss ")

private

The format for writing timestamps.

Definition at line 48 of file Logger.java.

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

◆ hostname

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

private

The hostname.

Definition at line 54 of file Logger.java.

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

The documentation for this class was generated from the following file:

crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/window/Logger.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Logger()

Member Function Documentation

◆ log()

◆ setHostname()

Member Data Documentation

◆ crossfireDrawextinfoListener

◆ crossfireDrawinfoListener

◆ crossfireQueryListener

◆ enabled

◆ format

◆ hostname