|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.zerjio.JIRC.IRCMessage
This class represents a basic message that is send over an IRC Connection.
It is recommended to take a look to the RFC 1459 to know what kinds of messages do exist and their exact formats. All IRC Messages should be a subclass of this generic one.
Constructor Summary | |
IRCMessage(java.lang.String prefix,
java.lang.String command,
java.lang.String params)
Constructs a general IRC message with a prefix, a command and its parameters. |
Method Summary | |
java.lang.String |
asString()
Gives a String representation of the IRC message. |
java.lang.String |
asStringWithoutPrefix()
Gives a String representation of the IRC message but ignoring its prefix. |
java.lang.String |
getCommand()
Gets the IRC message command. |
java.lang.String |
getHost()
Gets the host (part of prefix). |
boolean |
getMustBeDiscarded()
Gets if the IRC message must be discarded. |
java.lang.String |
getNick()
Gets the nick (part of prefix). |
java.lang.String |
getParams()
Gets the IRC message parameters. |
java.lang.String |
getPrefix()
Gets the IRC message prefix. |
int |
getUsedCount()
Gets how many times have this IRC message been used. |
java.lang.String |
getUser()
Gets the user (part of prefix). |
boolean |
isUsed()
Returns if the IRC message has been previously used. |
void |
markAsUsed()
Marks the IRC message as used. |
void |
mustBeDiscarded()
Marks the IRC message to be discarded. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IRCMessage(java.lang.String prefix, java.lang.String command, java.lang.String params)
prefix
- The IRC message prefix.command
- The IRC message command.params
- The IRC message parameters.Method Detail |
public java.lang.String getPrefix()
public java.lang.String getNick()
public java.lang.String getUser()
public java.lang.String getHost()
public java.lang.String getCommand()
public java.lang.String getParams()
public int getUsedCount()
public boolean isUsed()
true
if the IRC message has been previously used.
false
if the IRC message has NOT been previously used.public void markAsUsed()
public void mustBeDiscarded()
public boolean getMustBeDiscarded()
true
if the IRC message must be discarded.
false
if NOT must be discarded.public java.lang.String asString()
public java.lang.String asStringWithoutPrefix()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |