com.sun.tools.javac.main
Class JavacOption.Option

java.lang.Object
  com.sun.tools.javac.main.JavacOption.Option

All Implemented Interfaces:

JavacOption

Direct Known Subclasses:

JavacOption.HiddenOption, JavacOption.XOption

Enclosing interface:

JavacOption

public static class JavacOption.Option
extends java.lang.Object
implements JavacOption

This class represents an option recognized by the main program

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.tools.javac.main.JavacOption

JavacOption.ChoiceKind, JavacOption.HiddenOption, JavacOption.Option, JavacOption.OptionKind, JavacOption.XOption

Field Summary

(package private) java.lang.String	argsNameKey Documentation key for arguments.
(package private) JavacOption.ChoiceKind	choiceKind The kind of choices for this option, if any.
(package private) java.util.Collection<java.lang.String>	choices The choices for this option, if any.
(package private) java.lang.String	descrKey Documentation key for description.
(package private) boolean	hasSuffix Suffix option (-foo=bar or -foo:bar)
(package private) OptionName	name Option string.

Constructor Summary

JavacOption.Option(OptionName name, java.lang.String descrKey)

JavacOption.Option(OptionName name, java.lang.String descrKey, JavacOption.ChoiceKind choiceKind, java.util.Collection<java.lang.String> choices)

JavacOption.Option(OptionName name, java.lang.String descrKey, JavacOption.ChoiceKind choiceKind, java.lang.String... choices)

JavacOption.Option(OptionName name, java.lang.String argsNameKey, java.lang.String descrKey)

Method Summary

JavacOption.OptionKind	getKind()
OptionName	getName()
boolean	hasArg() Does this option take a (separate) operand?
(package private) void	help(java.io.PrintWriter out) Print a line of documentation describing this option, if standard.
(package private) java.lang.String	helpSynopsis()
boolean	matches(java.lang.String option) Does argument string match option pattern?
boolean	process(Options options, java.lang.String option) Process the option (without arg).
boolean	process(Options options, java.lang.String option, java.lang.String arg) Process the option (with arg).
java.lang.String	toString()
(package private) void	xhelp(java.io.PrintWriter out) Print a line of documentation describing this option, if non-standard.

Methods inherited from class java.lang.Object

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

Field Detail

name

OptionName name

Option string.

argsNameKey

java.lang.String argsNameKey

Documentation key for arguments.

descrKey

java.lang.String descrKey

Documentation key for description.

hasSuffix

boolean hasSuffix

Suffix option (-foo=bar or -foo:bar)

choiceKind

JavacOption.ChoiceKind choiceKind

The kind of choices for this option, if any.

choices

java.util.Collection<java.lang.String> choices

The choices for this option, if any.

Constructor Detail

JavacOption.Option

JavacOption.Option(OptionName name,
                   java.lang.String argsNameKey,
                   java.lang.String descrKey)

JavacOption.Option

JavacOption.Option(OptionName name,
                   java.lang.String descrKey)

JavacOption.Option

JavacOption.Option(OptionName name,
                   java.lang.String descrKey,
                   JavacOption.ChoiceKind choiceKind,
                   java.lang.String... choices)

JavacOption.Option

JavacOption.Option(OptionName name,
                   java.lang.String descrKey,
                   JavacOption.ChoiceKind choiceKind,
                   java.util.Collection<java.lang.String> choices)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hasArg

public boolean hasArg()

Description copied from interface: JavacOption

Does this option take a (separate) operand?

Specified by:

hasArg in interface JavacOption

Returns:

true if this option takes a separate operand

matches

public boolean matches(java.lang.String option)

Description copied from interface: JavacOption

Does argument string match option pattern?

Specified by:

matches in interface JavacOption

Parameters:

option - the command line argument string

Returns:

true if arg matches this option

help

void help(java.io.PrintWriter out)

Print a line of documentation describing this option, if standard.

Parameters:

out - the stream to which to write the documentation

helpSynopsis

java.lang.String helpSynopsis()

xhelp

void xhelp(java.io.PrintWriter out)

Print a line of documentation describing this option, if non-standard.

Parameters:

out - the stream to which to write the documentation

process

public boolean process(Options options,
                       java.lang.String option,
                       java.lang.String arg)

Process the option (with arg). Return true if error detected.

Specified by:

process in interface JavacOption

Parameters:

options - the accumulated set of analyzed options

option - the option to be processed

arg - the arg for the option to be processed

Returns:

true if an error was detected

process

public boolean process(Options options,
                       java.lang.String option)

Process the option (without arg). Return true if error detected.

Specified by:

process in interface JavacOption

Parameters:

options - the accumulated set of analyzed options

option - the option to be processed

Returns:

true if an error was detected

getKind

public JavacOption.OptionKind getKind()

Specified by:

getKind in interface JavacOption

getName

public OptionName getName()

Specified by:

getName in interface JavacOption