jdiff

Class Options

public class Options extends Object

Class to handle options for JDiff. See the file LICENSE.txt for copyright details.
Field Summary
static StringcmdOptions
All the options passed on the command line.
Constructor Summary
Options()
Default constructor.
Method Summary
static intoptionLength(String option)
Returns the "length" of a given option.
static voidusage()
Display the arguments for JDiff.
static booleanvalidOptions(String[][] options, DocErrorReporter reporter)
After parsing the available options using Options, Javadoc invokes this method with an array of options-arrays, where the first item in any array is the option, and subsequent items in that array are its arguments.

Field Detail

cmdOptions

public static String cmdOptions
All the options passed on the command line. Logged to XML.

Constructor Detail

Options

public Options()
Default constructor.

Method Detail

optionLength

public static int optionLength(String option)
Returns the "length" of a given option. If an option takes no arguments, its length is one. If it takes one argument, its length is two, and so on. This method is called by Javadoc to parse the options it does not recognize. It then calls Options to validate them.
Note:
The options arrive as case-sensitive strings. For options that are not case-sensitive, use toLowerCase() on the option string before comparing it.

Parameters: option a String containing an option

Returns: an int telling how many components that option has

usage

public static void usage()
Display the arguments for JDiff.

validOptions

public static boolean validOptions(String[][] options, DocErrorReporter reporter)
After parsing the available options using Options, Javadoc invokes this method with an array of options-arrays, where the first item in any array is the option, and subsequent items in that array are its arguments. So, if -print is an option that takes no arguments, and -copies is an option that takes 1 argument, then
     -print -copies 3
 
produces an array of arrays that looks like:
      option[0][0] = -print
      option[1][0] = -copies
      option[1][1] = 3
 
(By convention, command line switches start with a "-", but they don't have to.)

Note:
Javadoc passes allparameters to this method, not just those that Javadoc doesn't recognize. The only way to identify unexpected arguments is therefore to check for every Javadoc parameter as well as doclet parameters.

Parameters: options an array of String arrays, one per option reporter a DocErrorReporter for generating error messages

Returns: true if no errors were found, and all options are valid