Package net.sf.freecol.common.networking

Class ErrorMessage

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.ObjectMessage

net.sf.freecol.common.networking.ErrorMessage

public class ErrorMessage
extends ObjectMessage

The message sent when an error occurs.

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	MESSAGE_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
ErrorMessage(java.lang.Exception ex)	Create a new ErrorMessage from an exception with the standard client error template as the fallback.
ErrorMessage(java.lang.String message)	Create a new ErrorMessage with the standard client error template and given message.
ErrorMessage(java.lang.String key, java.lang.Exception ex)	Create a new ErrorMessage from an exception using a template key that expects a %message% parameter.
ErrorMessage(Game game, FreeColXMLReader xr)	Create a new ErrorMessage from a stream.
ErrorMessage(StringTemplate template)	Create a new ErrorMessage with the given template
ErrorMessage(StringTemplate template, java.lang.String message)	Create a new ErrorMessage with the given template and optional 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.
private java.lang.String	getMessage()	Get the non-i18n message.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
private StringTemplate	getTemplate()	Get the template.

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

appendChild, appendChildren, getChildCount, getChildren, setChildren

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

currentPlayerMessage, getType, serverHandler, 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

MESSAGE_TAG

private static final java.lang.String MESSAGE_TAG

See Also:

Constant Field Values

Constructor Detail

ErrorMessage

public ErrorMessage(StringTemplate template,
                    java.lang.String message)

Create a new ErrorMessage with the given template and optional message.

Parameters:

template - The StringTemplate to send.

message - An optional non-i18n message.

ErrorMessage

public ErrorMessage(StringTemplate template)

Create a new ErrorMessage with the given template

Parameters:

template - The StringTemplate to send.

ErrorMessage

public ErrorMessage(java.lang.String message)

Create a new ErrorMessage with the standard client error template and given message.

Parameters:

message - The message.

ErrorMessage

public ErrorMessage(java.lang.Exception ex)

Create a new ErrorMessage from an exception with the standard client error template as the fallback.

Parameters:

ex - The Exception to use.

ErrorMessage

public ErrorMessage(java.lang.String key,
                    java.lang.Exception ex)

Create a new ErrorMessage from an exception using a template key that expects a %message% parameter.

Parameters:

key - The template key.

ex - The Exception to extract a message from.

ErrorMessage

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

Create a new ErrorMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem reading the stream.

Method Detail

getTemplate

private StringTemplate getTemplate()

Get the template.

Returns:

The template.

getMessage

private java.lang.String getMessage()

Get the non-i18n message.

Returns:

The message.

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.