DBVIEW
Public Member Functions | Private Attributes
org.dbview.runtime.cli.CliOptionsProfileName Class Reference
Inheritance diagram for org.dbview.runtime.cli.CliOptionsProfileName:
Inheritance graph
[legend]
Collaboration diagram for org.dbview.runtime.cli.CliOptionsProfileName:
Collaboration graph
[legend]

List of all members.

Public Member Functions

String getProfileName ()
Hashtable< String, Boolean > options ()
String toString ()
String[] extractArgvForThisSet (String[] in_argv)
String[] shrink ()

Private Attributes

String __name = null

Detailed Description

This class contains the CLI option used to extract a profile's name from the command line.

Remarks:
This class is designed to be used with the library Args4j.
This class is not public.
Author:
Denis Beurive

Definition at line 1154 of file CliParser.java.

Member Function Documentation

String [] org.dbview.utils.args4j.OptionContainer.extractArgvForThisSet ( String[]  in_argv) [inherited]

This method extracts the command line arguments that apply to these options, from a given list of arguments.

Remarks:
This method is used to implement a 2 stages command line parsing. Sometimes, it is necessary to extract a part of information from the command line in order to parse the all arguments.
Parameters:
in_argvList of arguments.
Returns:
The method returns the list of command line arguments that applies to this options' container.

Definition at line 106 of file OptionContainer.java.

Referenced by org.dbview.runtime.cli.CliParser.__tryExport().

String org.dbview.runtime.cli.CliOptionsProfileName.getProfileName ( )

Returns the name of the profile.

Returns:
Returns the name of the profile.

Definition at line 1164 of file CliParser.java.

Referenced by org.dbview.runtime.cli.CliParser.__tryExport().

Hashtable<String, Boolean> org.dbview.utils.args4j.OptionContainer.options ( ) [inherited]

This method returns the list of command line option strings ("-host", "-user", ...). For each command line option string, the list contains a flag that indicates whether the option takes an argument or not.

Returns:
The method returns a hash.
  • Key: The command option string.
  • Value: A boolean value that indicates whether the option takes an argument or not.

Definition at line 54 of file OptionContainer.java.

Referenced by org.dbview.utils.args4j.OptionContainer.extractArgvForThisSet(), and org.dbview.utils.args4j.OptionContainer.toString().

String [] org.dbview.utils.args4j.OptionContainer.shrink ( ) [inherited]

This method returns the list of command line arguments that remains after the command line parsing.

Returns:
The method returns the list of command line arguments that remains after the command line parsing.

Definition at line 148 of file OptionContainer.java.

String org.dbview.utils.args4j.OptionContainer.toString ( ) [inherited]

This method is mainly used for debugging.

Returns:
The method returns a string that represents the container's state.

Definition at line 83 of file OptionContainer.java.

Member Data Documentation

String org.dbview.runtime.cli.CliOptionsProfileName.__name = null [private]

Name of the profile.

Definition at line 1158 of file CliParser.java.

Referenced by org.dbview.runtime.cli.CliOptionsProfileName.getProfileName().

The documentation for this class was generated from the following file: