summaryrefslogtreecommitdiffstats
path: root/EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java
diff options
context:
space:
mode:
Diffstat (limited to 'EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java')
-rw-r--r--EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java99
1 files changed, 0 insertions, 99 deletions
diff --git a/EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java b/EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java
deleted file mode 100644
index a1564d9ec..000000000
--- a/EssentialsUpdate/src/f00f/net/irc/martyr/InCommand.java
+++ /dev/null
@@ -1,99 +0,0 @@
-package f00f.net.irc.martyr;
-
-import java.util.Iterator;
-
-import f00f.net.irc.martyr.clientstate.ClientState;
-
-/**
- * Defines commands that come from the server. Errors and replies are
- * incoming commands.
- *
- * @see f00f.net.irc.martyr.errors.GenericError
- * @see f00f.net.irc.martyr.replies.GenericReply
- */
-public interface InCommand extends Command
-{
-
- /**
- * Some commands, when received by the server, can only occur in one
- * state. Thus, when this command is received, the protocol should
- * assume that it is in that state, and a state change may be
- * triggered. A command can use the 'unknown' state to indicate it
- * can be received in any state (for example, ping).
- *
- * @return State associated with command
- */
- State getState();
-
- /**
- * Every incoming command should know how to register itself with the
- * command register.
- *
- * @param commandRegister Command register we want to register with
- */
- void selfRegister( CommandRegister commandRegister );
-
- /**
- * Parses a string and produces a formed command object, if it can.
- * Should return null if it cannot form the command object. The
- * identifier is usually ignored, except in the special case where
- * commands can be identified by multiple identifiers. In that case,
- * the behaviour of the command may change in sublte ways.
- *
- * @param prefix Prefix of the command
- * @param identifier ID of the command
- * @param params Parameters of the command
- * @return InCommand instance for parsed command
- */
- InCommand parse( String prefix, String identifier, String params );
-
- /**
- * Gives the command a copy of the raw string from the server. Called
- * by IRCConnection after the command is parsed.
- *
- * @param str Sets the source string to be parsed
- */
- void setSourceString( String str );
-
- /**
- * Allows a third party to receive a copy of the raw string.
- *
- * @return The original source string from the server
- */
- String getSourceString();
-
- /**
- * Asks the command to ensure that information it knows about the
- * state the server thinks the client is in matches what we have.
- * Returns true if state changes were made.
- *
- * @param state Client state to be updated
- * @return True or false if changes were made
- */
- boolean updateClientState( ClientState state );
-
-
- /**
- * Returns an iterator of String objects over the attribute names
- * for this command. Warning: Still new, support for this is not
- * yet widespread. Should return all possible attribute keys, not just
- * those that have a value in the current context.
- *
- * @return Iterator of attribute keys
- */
- Iterator getAttributeKeys();
-
- /**
- * Returns the attribute, or null if the attribute does not exist,
- * or is not defined.
- *
- * @param key Attribute to get value of
- * @return Attribute value or null if attribute doesn't exist
- */
- String getAttribute( String key );
-
-}
-
-
-
-