org.checkerframework.framework.util

Interface OptionConfiguration

All Known Implementing Classes:

AccumulationChecker, AggregateChecker, AliasingChecker, AnnotationStatistics, BaseTypeChecker, CalledMethodsChecker, ClassValChecker, CompilerMessagesChecker, FenumChecker, FormatterChecker, GuiEffectChecker, I18nChecker, I18nFormatterChecker, I18nSubchecker, IndexChecker, InitializationChecker, InitializedFieldsChecker, InterningChecker, JavaCodeStatistics, KeyForSubchecker, LessThanChecker, LocalizableKeyChecker, LockChecker, LowerBoundChecker, MethodValChecker, MustCallChecker, MustCallNoCreatesMustCallForChecker, NullnessChecker, OptionalChecker, PropertyKeyChecker, PurityChecker, RegexChecker, ReportChecker, ResourceLeakChecker, ReturnsReceiverChecker, SameLenChecker, SearchIndexChecker, SignatureChecker, SignednessChecker, SourceChecker, SubstringIndexChecker, SubtypingChecker, TaintingChecker, TypeOutputtingChecker, UnitsChecker, UpperBoundChecker, ValueChecker

public interface OptionConfiguration

Provides methods for querying the Checker's options.

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanOption(String name) Determines the boolean value of the option with the given name.
boolean	getBooleanOption(String name, boolean defaultValue) Determines the boolean value of the option with the given name.
String	getOption(String name) Determines the value of the option with the given name.
String	getOption(String name, String defaultValue) Determines the boolean value of the option with the given name.
Map<String,String>	getOptions()
Set<String>	getSupportedOptions()
boolean	hasOption(String name) Check whether the given option is provided.

Method Detail

getOptions

Map<String,String> getOptions()

hasOption

boolean hasOption(String name)

Check whether the given option is provided.

Parameters:

name - the name of the option to check

Returns:

true if the option name was provided, false otherwise

getOption

String getOption(String name)

Determines the value of the option with the given name.

Parameters:

name - the name of the option to check

getOption

String getOption(String name,
                 String defaultValue)

Determines the boolean value of the option with the given name. Returns defaultValue if the option is not set.

Parameters:

name - the name of the option to check

defaultValue - the default value to return if the option is not set

getBooleanOption

boolean getBooleanOption(String name)

Determines the boolean value of the option with the given name. Returns false if the option is not set.

Parameters:

name - the name of the option to check

getBooleanOption

boolean getBooleanOption(String name,
                         boolean defaultValue)

Determines the boolean value of the option with the given name. Returns the given default value if the option is not set.

Parameters:

name - the name of the option to check

defaultValue - the default value to use if the option is not set

getSupportedOptions

Set<String> getSupportedOptions()