Package 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 Details

    • getOptions

      Map<String,String> getOptions()
      Return all active options for this checker.
      Returns:
      all active options for this checker

    • hasOption

      boolean hasOption(String name)
      Check whether the given option is provided.

      Note that getOption(java.lang.String) can still return null even if hasOption returns true: this happens e.g. for -Amyopt

      Parameters:
      name - the name of the option to check
      Returns:
      true if the option name was provided, false otherwise

    • getOption

      @Nullable String getOption(String name)
      Determines the value of the option with the given name.

      Note that getOption can still return null even if hasOption(java.lang.String) returns true: this happens e.g. for -Amyopt

      Parameters:
      name - the name of the option to check
      Returns:
      the value of the option with the given name
      See Also:

    • 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
      Returns:
      the value of the option with the given name, or defaultValue
      See Also:

    • 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
      Returns:
      the boolean value of the option

    • 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
      Returns:
      the boolean value of the option

    • getStringsOption

      default List<String> getStringsOption(String name, char separator)
      Determines the string list value of the option with the given name. The option's value is split on the given separator. Returns an empty list if the option is not set.
      Parameters:
      name - the name of the option to check
      separator - the separator for list elements
      Returns:
      the list of options

    • getStringsOption

      List<String> getStringsOption(String name, char separator, List<String> defaultValue)
      Determines the string list value of the option with the given name. The option's value is split on the given separator. Returns the given default value if the option is not set.
      Parameters:
      name - the name of the option to check
      separator - the separator for list elements
      defaultValue - the default value to use if the option is not set
      Returns:
      the list of options

    • getStringsOption

      default List<String> getStringsOption(String name, String separator)
      Determines the string list value of the option with the given name. The option's value is split on the given separator. Returns an empty list if the option is not set.
      Parameters:
      name - the name of the option to check
      separator - the separator for list elements
      Returns:
      the list of options

    • getStringsOption

      List<String> getStringsOption(String name, String separator, List<String> defaultValue)
      Determines the string list value of the option with the given name. The option's value is split on the given separator. Returns the given default value if the option is not set.
      Parameters:
      name - the name of the option to check
      separator - the separator for list elements
      defaultValue - the default value to use if the option is not set
      Returns:
      the list of options

    • getSupportedOptions

      Set<String> getSupportedOptions()
      Map the Checker Framework version of SupportedOptions to the standard annotation provided version SupportedOptions.
      Returns:
      the supported options