votorola.a.response

Class CommandResponder.Base

java.lang.Object

CommandResponder.Base

All Implemented Interfaces:

CommandResponder

Direct Known Subclasses:

CR_Hello, CR_Help, CR_Reconstruct, CR_Version, CR_Vote

Enclosing interface:

CommandResponder

public abstract static class CommandResponder.Base
extends Object
implements CommandResponder

Base implementation of a command responder.

Nested Class Summary

Nested classes/interfaces inherited from interface CommandResponder

CommandResponder.AnonymousIssueException, CommandResponder.Base, CommandResponder.Session, CommandResponder.U

Field Summary

Fields

Modifier and Type	Field and Description
protected String	keyPrefix
protected VoterService	voterService

Constructor Summary

Constructors

Constructor and Description
CommandResponder.Base(VoterService voterService, String keyPrefix) Constructs a Base.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsAnonymousIssue() Returns false.
static String	canonicalEmail(String idString, String commandName, CommandResponder.Session session) Translates a personal identifier to a canonical email address.
String	commandName(CommandResponder.Session session) Returns the localized string for keyPrefix + "commandName".
protected static HashMap<String,Option>	compileBaseOptions(CommandResponder.Session session) Compiles a minimal map of options for a responder.
void	help(CommandResponder.Session session) Calls U.
protected int	parse(String[] argv, Map<String,Option> optionMap, CommandResponder.Session session) Parses the arguments against a formal option map, registering actual occurences in it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CommandResponder

respond

Field Detail

voterService

protected final VoterService voterService

keyPrefix

protected final String keyPrefix

Constructor Detail

CommandResponder.Base

public CommandResponder.Base(VoterService voterService,
                     String keyPrefix)

Constructs a Base.

Method Detail

compileBaseOptions

protected static HashMap<String,Option> compileBaseOptions(CommandResponder.Session session)

Compiles a minimal map of options for a responder.

canonicalEmail

public static String canonicalEmail(String idString,
                    String commandName,
                    CommandResponder.Session session)
                             throws AddressException

Translates a personal identifier to a canonical email address.

Parameters:

idString - the personal identifier as input by the user in the form of either an email address or a mailish username.

commandName - the localized name of this command responder.

Returns:

canonical form of email address, or null if 'id' is null.

Throws:

AddressException - if 'id' cannot be translated, in which case an error message is already output to the session reply builder.

See Also:

MailishUsername

parse

protected int parse(String[] argv,
        Map<String,Option> optionMap,
        CommandResponder.Session session)

Parses the arguments against a formal option map, registering actual occurences in it.

Parameters:

argv - the array of command name and arguments, per respond(argv,session). It will be re-arranged so that all options come first.

optionMap - the map against which to interpret argv.

Returns:

Normally returns the index of first non-option argument, as returned by Getopt.getOptind() after parsing, but incremented by one to skip past the command itself. Returns -1 if a parsing error occurs, in which case an error message and help prompt have already been appended to the reply.

acceptsAnonymousIssue

public boolean acceptsAnonymousIssue()

Returns false.

Specified by:

acceptsAnonymousIssue in interface CommandResponder

commandName

public String commandName(CommandResponder.Session session)

Returns the localized string for keyPrefix + "commandName".

Specified by:

commandName in interface CommandResponder

See Also:

../locale/CR.properties

help

public void help(CommandResponder.Session session)

Calls U.helpDefault(keyPrefix,session).

Specified by:

help in interface CommandResponder