irssibot.protocol
Class IrcMessage

java.lang.Object
  |
  +--irssibot.protocol.IrcMessage

Direct Known Subclasses:

JoinMessage, ModeMessage

public class IrcMessage

extends java.lang.Object

Represents an IRC protocol message from server.

The BNF definition for an irc message is:

 message    =  [ ":" prefix SPACE ] command [ params ] crlf
 params     =  *14( SPACE middle ) [ SPACE ":" trailing ]
 

Version:

$Name: $ $Revision: 1.4 $

Author:

Matti Dahlbom

See Also:

Field Summary

protected java.lang.String[]	arguments Parameters of the message, or null if none supplied.
protected java.lang.String	command Command part of the message
protected java.lang.String	prefix Prefix part of the message, or null if none supplied.
protected java.lang.String	raw The original actual message string.
protected java.lang.String	trailing Trailing part of the message, or null if none supplied.

Constructor Summary

	IrcMessage() Default constructor for creating empty reusable instance.
protected	IrcMessage(java.lang.String prefix, java.lang.String command, java.lang.String[] arguments, java.lang.String trailing, java.lang.String raw) Constructs with all the parts already parsed.

Method Summary

java.lang.String[]	getArguments() Returns the arguments, or null if none supplied.
java.lang.String	getCommand() Returns the command part.
java.lang.String	getPrefix() Returns the prefix part, or null if none supplied.
java.lang.String	getTrailing() Returns the trailing part, or null if none supplied.
static IrcMessage	parse(java.lang.String raw) Parses an raw irc message and returns an IrcMessage instance for it.
protected void	setData(java.lang.String prefix, java.lang.String command, java.lang.String[] arguments, java.lang.String trailing, java.lang.String raw) Sets the instance data to given values.
java.lang.String	toString() Returns the raw original message string.

Methods inherited from class java.lang.Object

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

Field Detail

prefix

protected java.lang.String prefix

Prefix part of the message, or null if none supplied.

command

protected java.lang.String command

Command part of the message

arguments

protected java.lang.String[] arguments

Parameters of the message, or null if none supplied.

trailing

protected java.lang.String trailing

Trailing part of the message, or null if none supplied.

raw

protected java.lang.String raw

The original actual message string.

Constructor Detail

IrcMessage

public IrcMessage()

Default constructor for creating empty reusable instance.

IrcMessage

protected IrcMessage(java.lang.String prefix,
                     java.lang.String command,
                     java.lang.String[] arguments,
                     java.lang.String trailing,
                     java.lang.String raw)

Constructs with all the parts already parsed.

Parameters:

prefix - prefix part

command - command part

arguments - arguments

trailing - trailing part

raw - the raw message

Method Detail

setData

protected void setData(java.lang.String prefix,
                       java.lang.String command,
                       java.lang.String[] arguments,
                       java.lang.String trailing,
                       java.lang.String raw)

Sets the instance data to given values. Used for instance reuse.

Parameters:

prefix - prefix part

command - command part

arguments - arguments

trailing - trailing part

raw - the raw message

parse

public static IrcMessage parse(java.lang.String raw)

Parses an raw irc message and returns an IrcMessage instance for it.

Parameters:

raw - raw message

Returns:

new instance

Throws:

java.lang.IllegalArgumentException - if the input cannot be interpreted as a valid IRC message.

toString

public java.lang.String toString()

Returns the raw original message string.

Overrides:

toString in class java.lang.Object

getPrefix

public java.lang.String getPrefix()

Returns the prefix part, or null if none supplied.

Returns:

prefix part

getCommand

public java.lang.String getCommand()

Returns the command part.

Returns:

command part

getArguments

public java.lang.String[] getArguments()

Returns the arguments, or null if none supplied.

Returns:

arguments

getTrailing

public java.lang.String getTrailing()

Returns the trailing part, or null if none supplied.

Returns:

trailing part