Interface Mode

All Known Implementing Classes:

ApplyMode, DisableMode, RemoveRolloutMode, RemoveUnusedMode, SuppressMode, TimingsMode

public interface Mode

A Mode represents a mode of operation in suppressible-error-prone that is enabled or enabled by a gradle property flag (see ModeName). Each mode will either require either the error_prone_check_api to be modified or not (see ModifyCheckApiOption), and return options for configuration shared by multiple Modes (see CommonOptions). Modes can interfere with each other, see ModeInterference.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	Mode.ModeOptionContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUPPRESSIBLE_ERROR_PRONE_MODE

Method Summary

Modifier and Type	Method	Description
default CommonOptions	configureAndReturnCommonOptions(Mode.ModeOptionContext context)	Apply configuration specific to the mode or return the CommonOptions for this mode.
default ModifyCheckApiOption	modifyCheckApi()

Field Details

SUPPRESSIBLE_ERROR_PRONE_MODE

static final String SUPPRESSIBLE_ERROR_PRONE_MODE

See Also:

• Constant Field Values

Method Details

modifyCheckApi

default ModifyCheckApiOption modifyCheckApi()

configureAndReturnCommonOptions

default CommonOptions configureAndReturnCommonOptions(Mode.ModeOptionContext context)

Apply configuration specific to the mode or return the CommonOptions for this mode.

Parameters:

context - Useful information to use to determine options or apply configuration