org.schwering.irc.lib.util.IRCConstants Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of irclib Show documentation

A Java Internet Relay Chat library

The newest version!

/**
 * IRClib - A Java Internet Relay Chat library
 * Copyright (C) 2006-2015 Christoph Schwering 
 * and/or other contributors as indicated by the @author tags.
 *
 * This library and the accompanying materials are made available under the
 * terms of the
 *  - GNU Lesser General Public License,
 *  - Apache License, Version 2.0 and
 *  - Eclipse Public License v1.0.
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY.
 */
package org.schwering.irc.lib.util;

import org.schwering.irc.lib.IRCEventListener;

/**
 * Contains constants: reply codes, error codes and mIRC color codes.
 * @author Christoph Schwering <[email protected]>
 * @since 1.10
 * @see IRCEventListener#onError(int, String)
 * @see IRCEventListener#onReply(int, String, String)
 */
public interface IRCConstants {

    /**
     * This is part of the mIRC code and shows that a color-code starts / ends.
     * Here it is as the ASCII decimal int 3.
     */
    char COLOR_INDICATOR = 3; // ASCII code

    /**
     * This is part of the mIRC code and shows that bold starts / ends.
     * Here it is as the ASCII decimal int 31.
     */
    char BOLD_INDICATOR = 31; // ASCII code

    /**
     * This is part of the mIRC code and shows that bold starts / ends.
     * Here it is as the ASCII decimal int 2.
     */
    char UNDERLINE_INDICATOR = 2; // ASCII code

    /**
     * This is part of the mIRC code and shows that bold, underline and colors
     * end.
     * Here it is as the ASCII decimal int 15.
     */
    char COLOR_END_INDICATOR = 15; // ASCII code

    /**
     * This is part of the mIRC code and indicates that the client's colors are
     * reversed (background -> foreground and foreground -> background).
     * Here it is as the ASCII decimal int 22.
     */
    char COLOR_REVERSE_INDICATOR = 22; // ASCII code

}