irc
Class IRCObject

java.lang.Object
  |
  +--irc.IRCObject
Direct Known Subclasses:
BasicCTCPFilter, CodingHandler, DCCChatServer, DCCFileHandler, IdentServer, IdentWrapper, IRCApplication, IRCServer, NickMenuHandler, RootInterpretor, ServerProtocol, Source

public class IRCObject
extends java.lang.Object

Root IRC Object.


Field Summary
protected  IRCConfiguration _ircConfiguration
          The global IRC configuration.
 
Constructor Summary
IRCObject(IRCConfiguration ircConfiguration)
          Create a new IRCObject.
 
Method Summary
 java.awt.Color getColor(int i)
          Get the i'th color of the color model.
 IRCConfiguration getIRCConfiguration()
          get the irc configuration.
 java.lang.String getText(int code)
          Get formatted text associated with the given text code, with no parameter.
 java.lang.String getText(int code, java.lang.String p1)
          Get formatted text associated with the given text code, with one parameter.
 java.lang.String getText(int code, java.lang.String p1, java.lang.String p2)
          Get formatted text associated with the given text code, with two parameters.
 java.lang.String getText(int code, java.lang.String p1, java.lang.String p2, java.lang.String p3)
          Get formatted text associated with the given text code, with three parameters.
 boolean getTimeStamp()
          Get the timestamp flag.
 void release()
          Release this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_ircConfiguration

protected IRCConfiguration _ircConfiguration
The global IRC configuration.

Constructor Detail

IRCObject

public IRCObject(IRCConfiguration ircConfiguration)
Create a new IRCObject.

Parameters:
ircConfiguration - the global irc configuration.
Method Detail

getIRCConfiguration

public IRCConfiguration getIRCConfiguration()
get the irc configuration.

Returns:
the global irc configuration.

release

public void release()
Release this object. No further method call can be performed on this object.


getText

public java.lang.String getText(int code)
Get formatted text associated with the given text code, with no parameter.

Parameters:
code - text code.
Returns:
formatted text.

getText

public java.lang.String getText(int code,
                                java.lang.String p1)
Get formatted text associated with the given text code, with one parameter.

Parameters:
code - text code.
p1 - first parameter.
Returns:
formatted text.

getText

public java.lang.String getText(int code,
                                java.lang.String p1,
                                java.lang.String p2)
Get formatted text associated with the given text code, with two parameters.

Parameters:
code - text code.
p1 - first parameter.
p2 - second parameter.
Returns:
formatted text.

getText

public java.lang.String getText(int code,
                                java.lang.String p1,
                                java.lang.String p2,
                                java.lang.String p3)
Get formatted text associated with the given text code, with three parameters.

Parameters:
code - text code.
p1 - first parameter.
p2 - second parameter.
p3 - third parameter.
Returns:
formatted text.

getColor

public java.awt.Color getColor(int i)
Get the i'th color of the color model.

Parameters:
i - index.
Returns:
color at index i.

getTimeStamp

public boolean getTimeStamp()
Get the timestamp flag.

Returns:
timestamp flag.