Package net.sf.freecol.common.networking

Class ChatMessage

java.lang.Object

net.sf.freecol.common.networking.Message

net.sf.freecol.common.networking.TrivialMessage

net.sf.freecol.common.networking.AttributeMessage

net.sf.freecol.common.networking.ChatMessage

public class ChatMessage
extends AttributeMessage

The message that contains a chat string.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.freecol.common.networking.Message

Message.MessagePriority

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	COLOR_TAG
private static java.lang.String	MESSAGE_TAG
private static java.lang.String	PRIVATE_TAG
private static java.lang.String	SENDER_TAG
static java.lang.String	TAG

Fields inherited from class net.sf.freecol.common.networking.AttributeMessage

attributes

Fields inherited from class net.sf.freecol.common.networking.TrivialMessage

continueMessage, disconnectMessage, endTurnMessage, enterRevengeModeMessage, reconnectMessage, requestLaunchMessage, retireMessage, startGameMessage

Fields inherited from class net.sf.freecol.common.networking.Message

logger, messagePriorityComparator

Constructor Summary

Constructors

Constructor	Description
ChatMessage(Game game, FreeColXMLReader xr)	Create a new ChatMessage from a stream.
ChatMessage(Player player, java.lang.String message, boolean privateChat)	Create a new ChatMessage with the supplied message.

Method Summary

Modifier and Type	Method	Description
void	aiHandler(FreeColServer freeColServer, AIPlayer aiPlayer)	AI-side handler for this message.
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
java.awt.Color	getColor()	Get the color.
java.lang.String	getMessage()	What is the text of this ChatMessage?
Message.MessagePriority	getPriority()	Get the priority of this type of message.
java.lang.String	getSender()	Who sent this ChatMessage?
boolean	isPrivate()	Is this ChatMessage private?
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.

Methods inherited from class net.sf.freecol.common.networking.AttributeMessage

canMerge, getStringAttribute, getStringAttributeMap, hasAttribute, setMergeable, setStringAttribute

Methods inherited from class net.sf.freecol.common.networking.TrivialMessage

appendChild, appendChildren, currentPlayerMessage, getChildCount, getChildren, getType, setChildren, setType

Methods inherited from class net.sf.freecol.common.networking.Message

clientGeneric, expected, getArrayAttributes, getBooleanAttribute, getChild, getChildren, getEnumAttribute, getIntegerAttribute, getPriorityLevel, igc, igc, invokeAndWait, invokeLater, isEmpty, isType, merge, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toString, toXML, writeAttributes, writeChildren

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

COLOR_TAG

private static final java.lang.String COLOR_TAG

See Also:

Constant Field Values

MESSAGE_TAG

private static final java.lang.String MESSAGE_TAG

See Also:

Constant Field Values

PRIVATE_TAG

private static final java.lang.String PRIVATE_TAG

See Also:

Constant Field Values

SENDER_TAG

private static final java.lang.String SENDER_TAG

See Also:

Constant Field Values

Constructor Detail

ChatMessage

public ChatMessage(Player player,
                   java.lang.String message,
                   boolean privateChat)

Create a new ChatMessage with the supplied message.

Parameters:

player - The player that is sending the message.

message - The text of the message to send.

privateChat - Whether this message is private.

ChatMessage

public ChatMessage(Game game,
                   FreeColXMLReader xr)
            throws javax.xml.stream.XMLStreamException

Create a new ChatMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - if the stream is corrupt.

Method Detail

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

aiHandler

public void aiHandler(FreeColServer freeColServer,
                      AIPlayer aiPlayer)

AI-side handler for this message. AI handlers always return null. FIXME: One day the FreeColServer should devolve to AIMain.

Overrides:

aiHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

aiPlayer - The AIPlayer the message was sent to.

clientHandler

public void clientHandler(FreeColClient freeColClient)

Client-side handler for this message. Client handlers always return null.

Overrides:

clientHandler in class TrivialMessage

Parameters:

freeColClient - The FreeColClient to handle this message.

serverHandler

public ChangeSet serverHandler(FreeColServer freeColServer,
                               ServerPlayer serverPlayer)

Server-side handler for this message.

Overrides:

serverHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

serverPlayer - The ServerPlayer that sent the request.

Returns:

A ChangeSet defining the response.

getColor

public java.awt.Color getColor()

Get the color.

Returns:

The new Color.

getMessage

public java.lang.String getMessage()

What is the text of this ChatMessage?

Returns:

The text of this ChatMessage.

isPrivate

public boolean isPrivate()

Is this ChatMessage private?

Returns:

True if this ChatMessage is private.

getSender

public java.lang.String getSender()

Who sent this ChatMessage?

Returns:

The sender tag for this ChatMessage.