org.checkerframework.framework.util.OptionConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

Show newest version

package org.checkerframework.framework.util;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.source.SupportedOptions;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

/** Provides methods for querying the Checker's options. */
public interface OptionConfiguration {

    /**
     * Return all active options for this checker.
     *
     * @return all active options for this checker
     */
    Map getOptions();

    /**
     * Check whether the given option is provided.
     *
     * Note that {@link #getOption} can still return null even if {@code hasOption} returns true:
     * this happens e.g. for {@code -Amyopt}
     *
     * @param name the name of the option to check
     * @return true if the option name was provided, false otherwise
     */
    boolean hasOption(String name);

    /**
     * Determines the value of the option with the given name.
     *
     * Note that {@code getOption} can still return null even if {@link #hasOption} returns true:
     * this happens e.g. for {@code -Amyopt}
     *
     * @param name the name of the option to check
     * @return the value of the option with the given name
     * @see #getOption(String,String)
     */
    @Nullable String getOption(String name);

    /**
     * Determines the boolean value of the option with the given name. Returns {@code defaultValue}
     * if the option is not set.
     *
     * @param name the name of the option to check
     * @param defaultValue the default value to return if the option is not set
     * @return the value of the option with the given name, or {@code defaultValue}
     * @see #getOption(String)
     */
    String getOption(String name, String defaultValue);

    /**
     * Determines the boolean value of the option with the given name. Returns false if the option
     * is not set.
     *
     * @param name the name of the option to check
     * @return the boolean value of the option
     */
    boolean getBooleanOption(String name);

    /**
     * Determines the boolean value of the option with the given name. Returns the given default
     * value if the option is not set.
     *
     * @param name the name of the option to check
     * @param defaultValue the default value to use if the option is not set
     * @return the boolean value of the option
     */
    boolean getBooleanOption(String name, boolean defaultValue);

    /**
     * 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.
     *
     * @param name the name of the option to check
     * @param separator the separator for list elements
     * @return the list of options
     */
    default List getStringsOption(String name, char separator) {
        return getStringsOption(name, separator, Collections.emptyList());
    }

    /**
     * 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.
     *
     * @param name the name of the option to check
     * @param separator the separator for list elements
     * @param defaultValue the default value to use if the option is not set
     * @return the list of options
     */
    public List getStringsOption(String name, char separator, List defaultValue);

    /**
     * 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.
     *
     * @param name the name of the option to check
     * @param separator the separator for list elements
     * @return the list of options
     */
    default List getStringsOption(String name, String separator) {
        return getStringsOption(name, separator, Collections.emptyList());
    }

    /**
     * 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.
     *
     * @param name the name of the option to check
     * @param separator the separator for list elements
     * @param defaultValue the default value to use if the option is not set
     * @return the list of options
     */
    public List getStringsOption(String name, String separator, List defaultValue);

    /**
     * Map the Checker Framework version of {@link SupportedOptions} to the standard annotation
     * provided version {@link javax.annotation.processing.SupportedOptions}.
     *
     * @return the supported options
     */
    Set getSupportedOptions();
}