wtanaka.praya.irc
Class IRCSelfPrivMessage

java.lang.Object
  |
  +--wtanaka.praya.obj.Obj
        |
        +--wtanaka.praya.obj.Message
              |
              +--wtanaka.praya.irc.IRCMessage
                    |
                    +--wtanaka.praya.irc.IRCSelfPrivMessage

All Implemented Interfaces:

java.io.Serializable

public class IRCSelfPrivMessage

extends IRCMessage

Represents an outgoing private message sent from you to a user.

See Also:

Serialized Form

Field Summary

(package private) java.lang.String	from
(package private) IRCUserViaPrivMsg	m_recipient
(package private) java.lang.String	messageText

Fields inherited from class wtanaka.praya.obj.Message

generatedBy, score

Fields inherited from class wtanaka.praya.obj.Obj

CONTENTS, date, DATE, FROM, privThread, REVCONTENTS, REVDATE, REVFROM, REVSCORE, REVSUBJECT, SCORE, secretObject, SUBJECT

Constructor Summary

IRCSelfPrivMessage(java.lang.String fromNick, IRCUserViaPrivMsg recipient, java.lang.String messageText, Protocol generatedBy)

Method Summary

java.lang.String	getContents()
java.lang.String	getFrom()
java.lang.String	getMessageText()
IRCUserViaPrivMsg	getRecipient()
java.lang.String	getSubject()
boolean	isSelfMessage() Is this message is an outgoing message generated by the person viewing it? The return value from this method acts acts as a tag on certain kinds of messages.
Recipient	replyRecipient() Gets the recipient to whom replies to this message will be sent, if applicable.

Methods inherited from class wtanaka.praya.obj.Message

changeScore, convertStringToHtml, getScore, getSourceProtocol, isStateChangeMessage, lessThan, renderAsHTML, renderAsHTML, renderAsString, setZombie, toString

Methods inherited from class wtanaka.praya.obj.Obj

getTimeStamp, isPrivileged, setPrivilegedThread, setSecretObject, setTimeStamp

Methods inherited from class java.lang.Object

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

Field Detail

m_recipient

IRCUserViaPrivMsg m_recipient

messageText

java.lang.String messageText

from

java.lang.String from

Constructor Detail

IRCSelfPrivMessage

public IRCSelfPrivMessage(java.lang.String fromNick,
                          IRCUserViaPrivMsg recipient,
                          java.lang.String messageText,
                          Protocol generatedBy)

Method Detail

getFrom

public java.lang.String getFrom()

Overrides:

getFrom in class Obj

getSubject

public java.lang.String getSubject()

Overrides:

getSubject in class Obj

getRecipient

public IRCUserViaPrivMsg getRecipient()

getMessageText

public java.lang.String getMessageText()

getContents

public java.lang.String getContents()

Overrides:

getContents in class Obj

isSelfMessage

public boolean isSelfMessage()

Description copied from class: Message

Is this message is an outgoing message generated by the person viewing it? The return value from this method acts acts as a tag on certain kinds of messages. If a message returns true from this method, that means that it was sent by the client that contains this reference. Likewise, if a protocol pushes a message itself, one that wasn't received from another source, that message must return true from this method. This makes it easy for bots to not talk to themselves.

Overrides:

isSelfMessage in class Message

Following copied from class: wtanaka.praya.obj.Message

Returns:

true if this is a self generated message, false otherwise

replyRecipient

public Recipient replyRecipient()

Description copied from class: Message

Gets the recipient to whom replies to this message will be sent, if applicable.

Overrides:

replyRecipient in class Message

Following copied from class: wtanaka.praya.obj.Message

Returns:

the recipient object for replies to this message. If there is no relevant recipient (e.g. this a logout message) returns null.