oracle.apps.fnd.applcore.flex.runtime.util
Class BCModeler.Arguments

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.util.BCModeler.Options
      oracle.apps.fnd.applcore.flex.runtime.util.BCModeler.Arguments

Enclosing class:

BCModeler

public static class BCModeler.Arguments
extends BCModeler.Options

List of arguments for a modeler.

Field Summary

Fields inherited from class oracle.apps.fnd.applcore.flex.runtime.util.BCModeler.Options

_optionMap

Constructor Summary

BCModeler.Arguments()
Constructs an Arguments object.

Method Summary

java.lang.Object	get(BCModeler.Parameter param) Gets an argument.
boolean	getBoolean(BCModeler.Parameter param) Gets an argument as a boolean value.
java.lang.String[]	getCommandLineArgs(boolean escapeWhenNeeded) Gets the list of the arguments for a command line.
FlexfieldTableUsage	getFlexfieldTableUsage() Gets a reference to a flexfield table usage based on the arguments.
java.lang.String	getString(BCModeler.Parameter param) Gets an argument as a string.
BCModeler.Arguments	getUnmodifiableInstance() Creates an unmodifiable instance of this object.
static BCModeler.Arguments	parseCommandLineArgs(java.lang.String[] args) Parses a list of command-line arguments.
void	put(BCModeler.Option option, java.lang.Object arg) Puts an optional argument.
void	put(BCModeler.Parameter param, java.lang.Object arg) Puts an argument.
java.lang.String	toString() Gets the list of arguments as a string.
void	validate() Validates the arguments.

Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.util.BCModeler.Options

get, getBoolean, getString

Methods inherited from class java.lang.Object

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

Constructor Detail

BCModeler.Arguments

public BCModeler.Arguments()

Constructs an Arguments object.

Method Detail

getUnmodifiableInstance

public BCModeler.Arguments getUnmodifiableInstance()

Creates an unmodifiable instance of this object.

Returns:

an unmodifiable instance of this object

put

public void put(BCModeler.Parameter param,
                java.lang.Object arg)

Puts an argument.

Parameters:

param - the parameter name

arg - the argument

put

public void put(BCModeler.Option option,
                java.lang.Object arg)

Description copied from class: BCModeler.Options

Puts an optional argument.

Overrides:

put in class BCModeler.Options

Parameters:

option - the option name

arg - the argument

get

public java.lang.Object get(BCModeler.Parameter param)

Gets an argument.

Parameters:

param - the parameter

Returns:

the argument

getString

public java.lang.String getString(BCModeler.Parameter param)

Gets an argument as a string.

Parameters:

param - the parameter

Returns:

the argument as string

getBoolean

public boolean getBoolean(BCModeler.Parameter param)

Gets an argument as a boolean value.

Parameters:

param - the parameter

Returns:

the argument as a boolean value

validate

public void validate()

Validates the arguments.

Throws:

java.lang.IllegalArgumentException - if any of the arguments is invalid.

getFlexfieldTableUsage

public FlexfieldTableUsage getFlexfieldTableUsage()

Gets a reference to a flexfield table usage based on the arguments.

Returns:

a reference to the flexfield table usage specified in the arguments

Throws:

java.lang.IllegalArgumentException - if any of the arguments is invalid

getCommandLineArgs

public java.lang.String[] getCommandLineArgs(boolean escapeWhenNeeded)

Gets the list of the arguments for a command line. Note that if escapeWhenNeeded is true, you may not call run(String[], PrintStream) with the return argument list directly, because some of the arguments will not be unescaped.

Parameters:

escapeWhenNeeded - true if arguments should be escaped when needed

Returns:

the list of the arguments

Throws:

java.lang.IllegalArgumentException - if any of the argument is invalid

See Also:

parseCommandLineArgs(java.lang.String[])

parseCommandLineArgs

public static BCModeler.Arguments parseCommandLineArgs(java.lang.String[] args)

Parses a list of command-line arguments. All unrecognized arguments are added as options.

Parameters:

args - the list of command-line arguments

Returns:

the modeler arguments

Throws:

java.lang.IllegalArgumentException - if any of the argument is invalid

See Also:

getCommandLineArgs(boolean)

toString

public java.lang.String toString()

Gets the list of arguments as a string.

Overrides:

toString in class java.lang.Object

Returns:

the list of arguments as a string