org.jibble.pircbot
Class Colors

java.lang.Object
  extended byorg.jibble.pircbot.Colors

public class Colors
extends java.lang.Object

The Colors class provides several static fields and methods that you may find useful when writing an IRC Bot.

This class contains constants that are useful for formatting lines sent to IRC servers. These constants allow you to apply various formatting to the lines, such as colours, boldness, underlining and reverse text.

The class contains static methods to remove colours and formatting from lines of IRC text.

Here are some examples of how to use the contants from within a class that extends PircBot and imports org.jibble.pircbot.*;

 sendMessage("#cs", Colors.BOLD + "A bold hello!");
     A bold hello!
 sendMessage("#cs", Colors.RED + "Red" + Colors.NORMAL + " text");
     Red text
 sendMessage("#cs", Colors.BOLD + Colors.RED + "Bold and red");
     Bold and red
Please note that some IRC channels may be configured to reject any messages that use colours. Also note that older IRC clients may be unable to correctly display lines that contain colours and other control characters.

Note that this class name has been spelt in the American style in order to remain consistent with the rest of the Java API.

Since:
0.9.12

Field Summary
static java.lang.String BLACK
          Black coloured text.
static java.lang.String BLUE
          Blue coloured text.
static java.lang.String BOLD
          Bold text.
static java.lang.String BROWN
          Brown coloured text.
static java.lang.String CYAN
          Cyan coloured text.
static java.lang.String DARK_BLUE
          Dark blue coloured text.
static java.lang.String DARK_GRAY
          Dark gray coloured text.
static java.lang.String DARK_GREEN
          Dark green coloured text.
static java.lang.String GREEN
          Green coloured text.
static java.lang.String LIGHT_GRAY
          Light gray coloured text.
static java.lang.String MAGENTA
          Magenta coloured text.
static java.lang.String NORMAL
          Removes all previously applied color and formatting attributes.
static java.lang.String OLIVE
          Olive coloured text.
static java.lang.String PURPLE
          Purple coloured text.
static java.lang.String RED
          Red coloured text.
static java.lang.String REVERSE
          Reversed text (may be rendered as italic text in some clients).
static java.lang.String TEAL
          Teal coloured text.
static java.lang.String UNDERLINE
          Underlined text.
static java.lang.String WHITE
          White coloured text.
static java.lang.String YELLOW
          Yellow coloured text.
 
Method Summary
static java.lang.String removeColors(java.lang.String line)
          Removes all colours from a line of IRC text.
static java.lang.String removeFormatting(java.lang.String line)
          Remove formatting from a line of IRC text.
static java.lang.String removeFormattingAndColors(java.lang.String line)
          Removes all formatting and colours from a line of IRC text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORMAL

public static final java.lang.String NORMAL
Removes all previously applied color and formatting attributes.

See Also:
Constant Field Values

BOLD

public static final java.lang.String BOLD
Bold text.

See Also:
Constant Field Values

UNDERLINE

public static final java.lang.String UNDERLINE
Underlined text.

See Also:
Constant Field Values

REVERSE

public static final java.lang.String REVERSE
Reversed text (may be rendered as italic text in some clients).

See Also:
Constant Field Values

WHITE

public static final java.lang.String WHITE
White coloured text.

See Also:
Constant Field Values

BLACK

public static final java.lang.String BLACK
Black coloured text.

See Also:
Constant Field Values

DARK_BLUE

public static final java.lang.String DARK_BLUE
Dark blue coloured text.

See Also:
Constant Field Values

DARK_GREEN

public static final java.lang.String DARK_GREEN
Dark green coloured text.

See Also:
Constant Field Values

RED

public static final java.lang.String RED
Red coloured text.

See Also:
Constant Field Values

BROWN

public static final java.lang.String BROWN
Brown coloured text.

See Also:
Constant Field Values

PURPLE

public static final java.lang.String PURPLE
Purple coloured text.

See Also:
Constant Field Values

OLIVE

public static final java.lang.String OLIVE
Olive coloured text.

See Also:
Constant Field Values

YELLOW

public static final java.lang.String YELLOW
Yellow coloured text.

See Also:
Constant Field Values

GREEN

public static final java.lang.String GREEN
Green coloured text.

See Also:
Constant Field Values

TEAL

public static final java.lang.String TEAL
Teal coloured text.

See Also:
Constant Field Values

CYAN

public static final java.lang.String CYAN
Cyan coloured text.

See Also:
Constant Field Values

BLUE

public static final java.lang.String BLUE
Blue coloured text.

See Also:
Constant Field Values

MAGENTA

public static final java.lang.String MAGENTA
Magenta coloured text.

See Also:
Constant Field Values

DARK_GRAY

public static final java.lang.String DARK_GRAY
Dark gray coloured text.

See Also:
Constant Field Values

LIGHT_GRAY

public static final java.lang.String LIGHT_GRAY
Light gray coloured text.

See Also:
Constant Field Values
Method Detail

removeColors

public static java.lang.String removeColors(java.lang.String line)
Removes all colours from a line of IRC text.

Parameters:
line - the input text.
Returns:
the same text, but with all colours removed.
Since:
PircBot 1.2.0

removeFormatting

public static java.lang.String removeFormatting(java.lang.String line)
Remove formatting from a line of IRC text.

Parameters:
line - the input text.
Returns:
the same text, but without any bold, underlining, reverse, etc.
Since:
PircBot 1.2.0

removeFormattingAndColors

public static java.lang.String removeFormattingAndColors(java.lang.String line)
Removes all formatting and colours from a line of IRC text.

Parameters:
line - the input text.
Returns:
the same text, but without formatting and colour characters.
Since:
PircBot 1.2.0