com.swath.event
Class PrivateMessage

java.lang.Object
  com.swath.event.SwathEvent
      com.swath.event.PrivateMessage

All Implemented Interfaces:

EventIfc

public final class PrivateMessage

extends com.swath.event.SwathEvent

The PrivateMessage event.
Posted: When a private message arrives for you.

Since:

SWATH 1.7

See Also:

FedCommMessage, SSRadioMessage, TradeWarsMessage

Method Summary

java.lang.String	getClassName() Gets the event class name.
java.lang.String	getMessage() Gets the message text.
Trader	getSender() Gets the sender of the message.
boolean	isEventClass(java.lang.Class eventClass) Indicates if this event matches a given event class.
boolean	isUserDefined() Indicates if this event is user defined or not.
boolean	wasEncrypted() Indicates if the message was encrypted or not.

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public java.lang.String getMessage()

Gets the message text.

Returns:

The message.

Since:

SWATH 1.7

wasEncrypted

public boolean wasEncrypted()

Indicates if the message was encrypted or not.

Returns:

true if the message was encrypted, otherwise false.

Since:

SWATH 1.7

getSender

public Trader getSender()

Gets the sender of the message.

Returns:

The sender.

Since:

SWATH 1.7

isEventClass

public final boolean isEventClass(java.lang.Class eventClass)

Description copied from interface: EventIfc

Indicates if this event matches a given event class.

Specified by:

isEventClass in interface EventIfc

Parameters:

eventClass - The event class.

Returns:

true if this event is of the same class, otherwise false.

isUserDefined

public final boolean isUserDefined()

Description copied from interface: EventIfc

Indicates if this event is user defined or not.

Specified by:

isUserDefined in interface EventIfc

Returns:

true if user defined, otherwise false.

getClassName

public final java.lang.String getClassName()

Description copied from interface: EventIfc

Gets the event class name.

Specified by:

getClassName in interface EventIfc

Returns:

The class name.