IRCCommand (IRClib 2.0.0.Alpha3 API)

java.lang.Object
- java.lang.Enum<IRCCommand>
- - org.schwering.irc.lib.util.IRCCommand

All Implemented Interfaces:

Serializable, Comparable<IRCCommand>
```
public enum IRCCommand
extends Enum<IRCCommand>
```
An enum of IRC commands. Adapted from http://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands Hopefully, the list is correct and complete.

Author:

Peter Palaga

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIN` `ADMIN`
`AWAY` Syntax:
`CNOTICE` Syntax:
`CONNECT` Syntax:
`CPRIVMSG` Syntax:
`DIE` Syntax:
`ENCAP` Syntax:
`ERROR` Syntax:
`HELP` Syntax:
`INFO` Syntax:
`INVITE` Syntax:
`ISON` Syntax:
`JOIN` Syntax:
`KICK` Syntax:
`KILL` Syntax:
`KNOCK` Syntax:
`LINKS` Syntax:
`LIST` Syntax:
`LUSERS` Syntax:
`MODE` Syntax:
`MOTD` Syntax:
`NAMES` Syntax:
`NAMESX` Syntax:
`NICK` Syntax:
`NOTICE` Syntax:
`OPER` Syntax:
`PART` Syntax:
`PASS` Syntax:
`PING` Syntax:
`PONG` Syntax:
`PRIVMSG` Syntax:
`QUIT` Syntax:
`REHASH` Syntax:
`RESTART` Syntax:
`RULES` Syntax:
`SERVER` Syntax:
`SERVICE` Syntax:
`SERVLIST` Syntax:
`SETNAME` Syntax:
`SILENCE` Syntax:
`SQUERY` Syntax:
`SQUIT` Syntax:
`STATS` Syntax:
`SUMMON` Syntax:
`TIME` Syntax:
`TOPIC` Syntax:
`TRACE` Syntax:
`UHNAMES` Syntax:
`USER` Syntax:
`USERHOST` Syntatx:
`USERIP` Syntax:
`USERS` Syntax:
`VERSION` Syntax:
`WALLOPS` Syntax:
`WATCH` Syntax:
`WHO` Syntax:
`WHOIS` Syntax:
`WHOWAS` Syntax:

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static IRCCommand`	`fastValueOf(String command)` A `HashMap`-backed and `null`-tolerant alternative to `valueOf(String)`.
`static IRCCommand`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IRCCommand[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ADMIN
```
public static final IRCCommand ADMIN
```
    ADMIN
    Syntax:
```
 ADMIN [<servers>]
 
```
    Instructs the server to return information about the administrator of the server specified by <server>, or the current server if target is omitted.[1]
  - AWAY
```
public static final IRCCommand AWAY
```
    Syntax:
```
 AWAY [<message>]
 
```
    Provides the server with a message to automatically send in reply to a PRIVMSG directed at the user, but not to a channel they are on.[2] If <message> is omitted, the away status is removed.
    Defined in RFC 1459
  - CNOTICE
```
public static final IRCCommand CNOTICE
```
    Syntax:
```
 CNOTICE <nickname> <channel> :<message>
 
```
    Sends a channel NOTICE message to <nickname> on <channel> that bypasses flood protection limits. The target nickname must be in the same channel as the client issuing the command, and the client must be a channel operator.
    Normally an IRC server will limit the number of different targets a client can send messages to within a certain time frame to prevent spammers or bots from mass-messaging users on the network, however this command can be used by channel operators to bypass that limit in their channel. For example, it is often used by help operators that may be communicating with a large number of users in a help channel at one time.
    This command is not formally defined in an RFC, but is in use by some IRC networks. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the CNOTICE keyword
  - CPRIVMSG
```
public static final IRCCommand CPRIVMSG
```
    Syntax:
```
 CPRIVMSG <nickname> <channel> :<message>
 
```
    Sends a private message to <nickname> on <channel> that bypasses flood protection limits. The target nickname must be in the same channel as the client issuing the command, and the client must be a channel operator.
    Normally an IRC server will limit the number of different targets a client can send messages to within a certain time frame to prevent spammers or bots from mass-messaging users on the network, however this command can be used by channel operators to bypass that limit in their channel. For example, it is often used by help operators that may be communicating with a large number of users in a help channel at one time.
    This command is not formally defined in an RFC, but is in use by some IRC networks. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the CPRIVMSG keyword
  - CONNECT
```
public static final IRCCommand CONNECT
```
    Syntax:
```
 CONNECT <target server> [<port> [<remote server>]] (RFC 1459)
 
```
```
 CONNECT <target server> <port> [<remote server>] (RFC 2812)
 
```
    Instructs the server <remote server> (or the current server, if <remote server> is omitted) to connect to <target server> on port <port>.[3][4] This command should only be available to IRC Operators.
    Defined in RFC 1459; the <port> parameter became mandatory in RFC 2812
  - DIE
```
public static final IRCCommand DIE
```
    Syntax:
```
 DIE
 
```
    Instructs the server to shut down.[5]
    Defined in RFC 2812
  - ENCAP
```
public static final IRCCommand ENCAP
```
    Syntax:
    :<source> ENCAP <destination> <subcommand> <parameters> This command is for use by servers to encapsulate commands so that they will propagate across hub servers not yet updated to support them, and indicates the subcommand and its parameters should be passed unaltered to the destination, where it will be unencapsulated and parsed. This facilitates implementation of new features without a need to restart all servers before they are usable across the network.[6]
  - ERROR
```
public static final IRCCommand ERROR
```
    Syntax:
```
 ERROR <error message>
 
```
    This command is for use by servers to report errors to other servers. It is also used before terminating client connections.[7]
    Defined in RFC 1459
  - HELP
```
public static final IRCCommand HELP
```
    Syntax:
```
 HELP
 
```
    Requests the server help file.
    This command is not formally defined in an RFC, but is in use by most major IRC daemons.
  - INFO
```
public static final IRCCommand INFO
```
    Syntax:
```
 INFO [<target>]
 
```
    Returns information about the <target> server, or the current server if <target> is omitted.[8] Information returned includes the server's version, when it was compiled, the patch level, when it was started, and any other information which may be considered to be relevant.
    Defined in RFC 1459
  - INVITE
```
public static final IRCCommand INVITE
```
    Syntax:
```
 INVITE <nickname> <channel>
 
```
    Invites <nickname> to the channel <channel>.[9] <channel> does not have to exist, but if it does, only members of the channel are allowed to invite other clients. If the channel mode i is set, only channel operators may invite other clients.
    Defined in RFC 1459
  - ISON
```
public static final IRCCommand ISON
```
    Syntax:
```
 ISON <nicknames>
 
```
    Queries the server to see if the clients in the space-separated list <nicknames> are currently on the network.[10] The server returns only the nicknames that are on the network in a space-separated list. If none of the clients are on the network the server returns an empty list.
    Defined in RFC 1459
  - JOIN
```
public static final IRCCommand JOIN
```
    Syntax:
```
 JOIN <channels> [<keys>]
 
```
    Makes the client join the channels in the comma-separated list <channels>, specifying the passwords, if needed, in the comma-separated list <keys>.[11] If the channel(s) do not exist then they will be created.
    Defined in RFC 1459
  - KICK
```
public static final IRCCommand KICK
```
    Syntax:
```
 KICK <channel> <client> [<message>]
 
```
    Forcibly removes <client> from <channel>.[12] This command may only be issued by channel operators.
    Defined in RFC 1459
  - KILL
```
public static final IRCCommand KILL
```
    Syntax:
```
 KILL <client> <comment>
 
```
    Forcibly removes <client> from the network.[13] This command may only be issued by IRC operators.
    Defined in RFC 1459
  - KNOCK
```
public static final IRCCommand KNOCK
```
    Syntax:
```
 KNOCK <channel> [<message>]
 
```
    Sends a NOTICE to an invitation-only <channel> with an optional <message>, requesting an invite.
    This command is not formally defined by an RFC, but is supported by most major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the KNOCK keyword.
  - LINKS
```
public static final IRCCommand LINKS
```
    Syntax:
```
 LINKS [<remote server> [<server mask>]]
 
```
    Lists all server links matching <server mask>, if given, on <remote server>, or the current server if omitted.[14]
    Defined in RFC 1459
  - LIST
```
public static final IRCCommand LIST
```
    Syntax:
```
 LIST [<channels> [<server>]]
 
```
    Lists all channels on the server.[15] If the comma-separated list <channels> is given, it will return the channel topics. If <server> is given, the command will be forwarded to <server> for evaluation.
    Defined in RFC 1459
  - LUSERS
```
public static final IRCCommand LUSERS
```
    Syntax:
```
 LUSERS [<mask> [<server>]]
 
```
    Returns statistics about the size of the network.[16] If called with no arguments, the statistics will reflect the entire network. If <mask> is given, it will return only statistics reflecting the masked subset of the network. If <target> is given, the command will be forwarded to <server> for evaluation.
    Defined in RFC 2812
  - MODE
```
public static final IRCCommand MODE
```
    Syntax:
```
 MODE <nickname> <flags> (user)
 
```
```
 MODE <channel> <flags> [<args>]
 
```
    The MODE command is dual-purpose. It can be used to set both user and channel modes.[17]
    Defined in RFC 1459
  - MOTD
```
public static final IRCCommand MOTD
```
    Syntax:
```
 MOTD [<server>]
 
```
    Returns the message of the day on <server> or the current server if it is omitted.[18]
    Defined in RFC 2812
  - NAMES
```
public static final IRCCommand NAMES
```
    Syntax:
```
 NAMES [<channels>] (RFC 1459)
 
```
```
 NAMES [<channels> [<server>]] (RFC 2812)
 
```
    Returns a list of who is on the comma-separated list of <channels>, by channel name.[19] If <channels> is omitted, all users are shown, grouped by channel name with all users who are not on a channel being shown as part of channel "*". If <server> is specified, the command is sent to <server> for evaluation.[20]
    Defined in RFC 1459; the optional <server> parameter was added in RFC 2812
  - NAMESX
```
public static final IRCCommand NAMESX
```
    Syntax:
```
 PROTOCTL NAMESX
 
```
    Instructs the server to send names in an RPL_NAMES reply prefixed with their respective channel status. For example:
    With NAMESX
    :irc.server.net 353 Phyre = #SomeChannel :@+WiZ Without NAMESX
    :irc.server.net 353 Phyre = #SomeChannel :WiZ This command can ONLY be used if the NAMESX keyword is returned in an RPL_ISUPPORT (numeric 005) reply. It may also be combined with the UHNAMES command.
    This command is not formally defined in an RFC, but is recognized by most major IRC daemons.
  - NICK
```
public static final IRCCommand NICK
```
    Syntax:
```
 NICK <nickname> [<hopcount>] (RFC 1459)
 
```
```
 NICK <nickname> (RFC 2812)
 
```
    Allows a client to change their IRC nickname. Hopcount is for use between servers to specify how far away a nickname is from its home server.[21][22]
    Defined in RFC 1459; the optional <hopcount> parameter was removed in RFC 2812
  - NOTICE
```
public static final IRCCommand NOTICE
```
    Syntax:
```
 NOTICE <msgtarget> <message>
 
```
    This command works similarly to PRIVMSG, except automatic replies must never be sent in reply to NOTICE messages.[23]
    Defined in RFC 1459
  - OPER
```
public static final IRCCommand OPER
```
    Syntax:
```
 OPER <username> <password>
 
```
    Authenticates a user as an IRC operator on that server/network.[24]
    Defined in RFC 1459
  - PART
```
public static final IRCCommand PART
```
    Syntax:
```
 PART <channels> [<message>]
 
```
    Causes a user to leave the channels in the comma-separated list <channels>.[25]
    Defined in RFC 1459
  - PASS
```
public static final IRCCommand PASS
```
    Syntax:
```
 PASS <password>
 
```
    Sets a connection password.[26] This command must be sent before the NICK/USER registration combination.
    Defined in RFC 1459
  - PING
```
public static final IRCCommand PING
```
    Syntax:
```
 PING <server1> [<server2>]
 
```
    Tests the presence of a connection.[27] A PING message results in a PONG reply. If <server2> is specified, the message gets passed on to it.
    Defined in RFC 1459
  - PONG
```
public static final IRCCommand PONG
```
    Syntax:
```
 PONG <server1> [<server2>]
 
```
    This command is a reply to the PING command and works in much the same way.[28]
    Defined in RFC 1459
  - PRIVMSG
```
public static final IRCCommand PRIVMSG
```
    Syntax:
```
 PRIVMSG <msgtarget> <message>
 
```
    Sends <message> to <msgtarget>, which is usually a user or channel.[29]
    Defined in RFC 1459
  - QUIT
```
public static final IRCCommand QUIT
```
    Syntax:
```
 QUIT [<message>]
 
```
    Disconnects the user from the server.[30]
    Defined in RFC 1459
  - REHASH
```
public static final IRCCommand REHASH
```
    Syntax:
```
 REHASH
 
```
    Causes the server to re-read and re-process its configuration file(s).[31] This command can only be sent by IRC Operators.
    Defined in RFC 1459
  - RESTART
```
public static final IRCCommand RESTART
```
    Syntax:
```
 RESTART
 
```
    Restarts a server.[32] It may only be sent by IRC Operators.
    Defined in RFC 1459
  - RULES
```
public static final IRCCommand RULES
```
    Syntax:
```
 RULES
 
```
    Requests the server rules.
    This command is not formally defined in an RFC, but is used by most[which?] major IRC daemons.
  - SERVER
```
public static final IRCCommand SERVER
```
    Syntax:
```
 SERVER <servername> <hopcount> <info>
 
```
    The server message is used to tell a server that the other end of a new connection is a server.[33] This message is also used to pass server data over whole net. <hopcount> details how many hops (server connections) away <servername> is. <info> contains addition human-readable information about the server.
    Defined in RFC 1459
  - SERVICE
```
public static final IRCCommand SERVICE
```
    Syntax:
```
 SERVICE <nickname> <reserved> <distribution> <type> <reserved> <info>
 
```
    Registers a new service on the network.[34]
    Defined in RFC 2812
  - SERVLIST
```
public static final IRCCommand SERVLIST
```
    Syntax:
```
 SERVLIST [<mask> [<type>]]
 
```
    Lists the services currently on the network.[35]
    Defined in RFC 2812
  - SQUERY
```
public static final IRCCommand SQUERY
```
    Syntax:
```
 SQUERY <servicename> <text>
 
```
    Identical to PRIVMSG except the recipient must be a service.[36]
    Defined in RFC 2812
  - SQUIT
```
public static final IRCCommand SQUIT
```
    Syntax:
```
 SQUIT <server> <comment>
 
```
    Causes <server> to quit the network.[37]
    Defined in RFC 1459
  - SETNAME
```
public static final IRCCommand SETNAME
```
    Syntax:
```
 SETNAME <new real name>
 
```
    Allows a client to change the "real name" specified when registering a connection.
    This command is not formally defined by an RFC, but is in use by some IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the SETNAME keyword
  - SILENCE
```
public static final IRCCommand SILENCE
```
    Syntax:
```
 SILENCE [+/-<hostmask>]
 
```
    Adds or removes a host mask to a server-side ignore list that prevents matching users from sending the client messages. More than one mask may be specified in a space-separated list, each item prefixed with a "+" or "-" to designate whether it is being added or removed. Sending the command with no parameters returns the entries in the client's ignore list.
    This command is not formally defined in an RFC, but is supported by most[which?] major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the SILENCE keyword and the maximum number of entries a client may have in its ignore list. For example:
    :irc.server.net 005 WiZ WALLCHOPS WATCH=128 SILENCE=15 MODES=12 CHANTYPES=#
  - STATS
```
public static final IRCCommand STATS
```
    Syntax:
```
 STATS <query> [<server>]
 
```
    Returns statistics about the current server, or <server> if it's specified.[38]
    Defined in RFC 1459
  - SUMMON
```
public static final IRCCommand SUMMON
```
    Syntax:
```
 SUMMON <user> [<server>] (RFC 1459)
 
```
```
 SUMMON <user> [<server> [<channel>]] (RFC 2812)
 
```
    Gives users who are on the same host as <server> a message asking them to join IRC.[39][40]
    Defined in RFC 1459; the optional <channel> parameter was added in RFC 2812
  - TIME
```
public static final IRCCommand TIME
```
    Syntax:
```
 TIME [<server>]
 
```
    Returns the local time on the current server, or <server> if specified.[41]
    Defined in RFC 1459
  - TOPIC
```
public static final IRCCommand TOPIC
```
    Syntax:
```
 TOPIC <channel> [<topic>]
 
```
    Allows the client to query or set the channel topic on <channel>.[42] If <topic> is given, it sets the channel topic to <topic>. If channel mode +t is set, only a channel operator may set the topic.
    Defined in RFC 1459
  - TRACE
```
public static final IRCCommand TRACE
```
    Syntax:
```
 TRACE [<target>]
 
```
    Trace a path across the IRC network to a specific server or client, in a similar method to traceroute.[43]
    Defined in RFC 1459
  - UHNAMES
```
public static final IRCCommand UHNAMES
```
    Syntax:
```
 PROTOCTL UHNAMES
 
```
    Instructs the server to send names in an RPL_NAMES reply in the long format:
    With UHNAMES
    :irc.server.net 353 Phyre = #SomeChannel :WiZ!user@somehost Without UHNAMES
    :irc.server.net 353 Phyre = #SomeChannel :WiZ This command can ONLY be used if the UHNAMES keyword is returned in an RPL_ISUPPORT (numeric 005) reply. It may also be combined with the NAMESX command.
    This command is not formally defined in an RFC, but is recognized by most major IRC daemons.
  - USER
```
public static final IRCCommand USER
```
    Syntax:
```
 USER <username> <hostname> <servername> <realname> (RFC 1459)
 
```
```
 USER <user> <mode> <unused> <realname> (RFC 2812)
 
```
    This command is used at the beginning of a connection to specify the username, hostname, real name and initial user modes of the connecting client.[44][45] <realname> may contain spaces, and thus must be prefixed with a colon.
    Defined in RFC 1459, modified in RFC 2812
  - USERHOST
```
public static final IRCCommand USERHOST
```
    Syntatx:
```
 USERHOST <nickname> [<nickname> <nickname> ...]
 
```
    Returns a list of information about the nicknames specified.[46]
    Defined in RFC 1459
  - USERIP
```
public static final IRCCommand USERIP
```
    Syntax:
```
 USERIP <nickname>
 
```
    Requests the direct IP address of the user with the specified nickname.
    This command is often used to obtain the IP of an abusive user to more effectively perform a ban. It is unclear what, if any, privileges are required to execute this command on a server.
    This command is not formally defined by an RFC, but is in use by some IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the USERIP keyword.
  - USERS
```
public static final IRCCommand USERS
```
    Syntax:
```
 USERS [<server>]
 
```
    Returns a list of users and information about those users in a format similar to the UNIX commands who, rusers and finger.[47]
    Defined in RFC 1459
  - VERSION
```
public static final IRCCommand VERSION
```
    Syntax:
```
 VERSION [<server>]
 
```
    Returns the version of <server>, or the current server if omitted.[48]
    Defined in RFC 1459
  - WALLOPS
```
public static final IRCCommand WALLOPS
```
    Syntax:
```
 WALLOPS <message>
 
```
    Sends <message> to all operators connected to the server (RFC 1459), or all users with user mode 'w' set (RFC 2812).[49][50]
    Defined in RFC 1459
  - WATCH
```
public static final IRCCommand WATCH
```
    Syntax:
```
 WATCH [+/-<nicknames>]
 
```
    Adds or removes a user to a client's server-side friends list. More than one nickname may be specified in a space-separated list, each item prefixed with a "+" or "-" to designate whether it is being added or removed. Sending the command with no parameters returns the entries in the client's friends list.
    This command is not formally defined in an RFC, but is supported by most[which?] major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the WATCH keyword and the maximum number of entries a client may have in its friends list. For example:
    :irc.server.net 005 WiZ WALLCHOPS WATCH=128 SILENCE=15 MODES=12 CHANTYPES=#
  - WHO
```
public static final IRCCommand WHO
```
    Syntax:
```
 WHO [<name> ["o"]]
 
```
    Returns a list of users who match <name>.[51] If the flag "o" is given, the server will only return information about IRC Operators.
    Defined in RFC 1459
  - WHOIS
```
public static final IRCCommand WHOIS
```
    Syntax:
```
 WHOIS [<server>] <nicknames>
 
```
    Returns information about the comma-separated list of nicknames masks <nicknames>.[52] If <server> is given, the command is forwarded to it for processing.
    Defined in RFC 1459
  - WHOWAS
```
public static final IRCCommand WHOWAS
```
    Syntax:
```
 WHOWAS <nickname> [<count> [<server>]]
 
```
    Used to return information about a nickname that is no longer in use (due to client disconnection, or nickname changes).[53] If given, the server will return information from the last <count> times the nickname has been used. If <server> is given, the command is forwarded to it for processing. In RFC 2812, <nickname> can be a comma-separated list of nicknames.[54]
    Defined in RFC 1459
- Method Detail
  - values
```
public static IRCCommand[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IRCCommand c : IRCCommand.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IRCCommand valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - fastValueOf
```
public static IRCCommand fastValueOf(String command)
```
    A HashMap-backed and null-tolerant alternative to valueOf(String). The lookup is case-sensitive.
    
    Parameters:
    
    command - the command as a String
    
    Returns:
    
    the IRCCommand that corresponds to the given string command or null if no such command exists

Enum IRCCommand

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADMIN

AWAY

CNOTICE

CPRIVMSG

CONNECT

DIE

ENCAP

ERROR

HELP

INFO

INVITE

ISON

JOIN

KICK

KILL

KNOCK

LINKS

LIST

LUSERS

MODE

MOTD

NAMES

NAMESX

NICK

NOTICE

OPER

PART

PASS

PING

PONG

PRIVMSG

QUIT

REHASH

RESTART

RULES

SERVER

SERVICE

SERVLIST

SQUERY

SQUIT

SETNAME

SILENCE

STATS

SUMMON

TIME

TOPIC

TRACE

UHNAMES

USER

USERHOST

USERIP

USERS

VERSION

WALLOPS

WATCH

WHO

WHOIS

WHOWAS

Method Detail

values

valueOf

fastValueOf