oracle.ifs.protocols.commands.utils

Class CommandlineArgumentTranslator

java.lang.Object

oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

All Implemented Interfaces:

ArgumentTranslator

Direct Known Subclasses:

CupArgumentTranslator, CupCdArgumentTranslator, CupCookieArgumentTranslator, CupCpArgumentTranslator, CupDoneArgumentTranslator, CupFindArgumentTranslator, CupGetArgumentTranslator, CupHelpArgumentTranslator, CupLoginArgumentTranslator, CupLogoutArgumentTranslator, CupMkdirArgumentTranslator, CupModeArgumentTranslator, CupMvArgumentTranslator, CupPasvArgumentTranslator, CupPutArgumentTranslator, CupRmRefArgumentTranslator, CupSetCharArgumentTranslator, CupSetLangArgumentTranslator, CupShowCharArgumentTranslator, CupShowLangArgumentTranslator

public class CommandlineArgumentTranslator
extends Object
implements ArgumentTranslator

CommandlineArgumentTranslator interperates the InvocationContext.getinvocationArgs Object as a String and parses it out according positional and flagged arguments. This implementation throws an InvalidArgumentException if it encounters any args. Child classes should overload to handle expected arguments. The String is parsed using oracle.ifs.utilities.commandline.CommandlineArguments notion of Positional and flagged arguments.

Version:

1.0

Author:

Dave Long, Kevin Gillett

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMDKEY

Constructor Summary

Constructors

Constructor and Description
CommandlineArgumentTranslator() Construct a CommandlineArgumentTranslator.

Method Summary

Modifier and Type	Method and Description
protected int[]	getPotentialArgs() Gets the argument type a particular flag is expecting as defined by oracle.ifs.utilities.commandline.CommandlineArguments
protected String[]	getPotentialFlags() Gets the potentails flags that the oracle.ifs.utilities.commandline.CommandlineArguments object might be expecting.
protected void	handleFlag(String flagKey, String flagValue, CommandContext context, Hashtable translationState) Handles a specific Flag occurence.
protected void	handlePositional(int pos, String positional, CommandContext context, Hashtable translationState) Handles a specific Positional occurance.
protected void	initialize(CommandContext context, Object invoker, Hashtable translationState) Base implemtation does nothing
protected void	parse(String cmdline, CommandContext context, Hashtable translationState) Imposes the string parsing framework.
protected void	postParse(CommandContext context, Object invoker, Hashtable translationState) Called after parsing is complete.
void	translate(CommandContext context, Object cmdKey, Object invoker, Object args) A CommandlineArgumentTranslator casts the args object to a String and uses the notion of positionals and flagged arguments provided through a oracle.ifs.utilities.commandline.CommandlineArguments object.

Methods inherited from class java.lang.Object

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

Field Detail

CMDKEY

public static final String CMDKEY

See Also:

Constant Field Values

(Published)

Constructor Detail

CommandlineArgumentTranslator

public CommandlineArgumentTranslator()

Construct a CommandlineArgumentTranslator.

(Published)

Method Detail

translate

public final void translate(CommandContext context,
                            Object cmdKey,
                            Object invoker,
                            Object args)
                     throws IfsException

A CommandlineArgumentTranslator casts the args object to a String and uses the notion of positionals and flagged arguments provided through a oracle.ifs.utilities.commandline.CommandlineArguments object.

Specified by:

translate in interface ArgumentTranslator

Parameters:

context - the command's context.

cmdKey - the command's key within the invocation environment.

invoker - the command's invoker.

args - additional args to be interpreted.

Throws:

IfsException

See Also:

CommandContext, CommandInvoker

(Published)

initialize

protected void initialize(CommandContext context,
                          Object invoker,
                          Hashtable translationState)
                   throws IfsException

Base implemtation does nothing

Throws:

IfsException

(Published)

parse

protected void parse(String cmdline,
                     CommandContext context,
                     Hashtable translationState)
              throws IfsException

Imposes the string parsing framework.

Throws:

IfsException

(Published)

postParse

protected void postParse(CommandContext context,
                         Object invoker,
                         Hashtable translationState)
                  throws IfsException

Called after parsing is complete.

Throws:

IfsException

(Published)

getPotentialFlags

protected String[] getPotentialFlags()

Gets the potentails flags that the oracle.ifs.utilities.commandline.CommandlineArguments object might be expecting.

(Published)

getPotentialArgs

protected int[] getPotentialArgs()

Gets the argument type a particular flag is expecting as defined by oracle.ifs.utilities.commandline.CommandlineArguments

(Published)

handlePositional

protected void handlePositional(int pos,
                                String positional,
                                CommandContext context,
                                Hashtable translationState)
                         throws IfsException

Handles a specific Positional occurance. Base Implementation throws an InvalidArgumentException.

Throws:

IfsException

(Published)

handleFlag

protected void handleFlag(String flagKey,
                          String flagValue,
                          CommandContext context,
                          Hashtable translationState)
                   throws IfsException

Handles a specific Flag occurence. Base Implementation throws an InvalidArgumentException.

Throws:

IfsException

(Published)