Interface ModifyCheckApiOption

All Known Implementing Classes:

ModifyCheckApiOption.DoNotModify, ModifyCheckApiOption.MustModify, ModifyCheckApiOption.NoEffect

public sealed interface ModifyCheckApiOption
permits ModifyCheckApiOption.DoNotModify, ModifyCheckApiOption.NoEffect, ModifyCheckApiOption.MustModify

suppressible-error-prone is powered by an artifact transform that modifies the error_prone_check_api jar. Some modes must not run with this jar modified, some must run with it modified (and then some may or may not need the VisitorState class modified), and some don't care. This class represents these states and allows combining them sensibly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ModifyCheckApiOption.CombinedValue
static enum	ModifyCheckApiOption.DoNotModify
static final record	ModifyCheckApiOption.MustModify
static enum	ModifyCheckApiOption.NoEffect

Method Summary

Modifier and Type	Method	Description
static ModifyCheckApiOption.CombinedValue	combine(Collection<ModifyCheckApiOption> options)
static ModifyCheckApiOption	doNotModify()	The error_prone_check_api jar must not be modified.
default Set<com.palantir.suppressibleerrorprone.transform.ModifiedFile>	getModifiedFiles()
static ModifyCheckApiOption.MustModify	mustModify(com.palantir.suppressibleerrorprone.transform.ModifiedFile... modifiedFile)	Modify these files in the error-prone API.
static ModifyCheckApiOption	noEffect()	It doesn't matter whether the error_prone_check_api jar is modified or not.

Method Details

doNotModify

static ModifyCheckApiOption doNotModify()

The error_prone_check_api jar must not be modified.

noEffect

static ModifyCheckApiOption noEffect()

It doesn't matter whether the error_prone_check_api jar is modified or not. This will have no effect on the decision made.

mustModify

static ModifyCheckApiOption.MustModify mustModify(com.palantir.suppressibleerrorprone.transform.ModifiedFile... modifiedFile)

Modify these files in the error-prone API.

getModifiedFiles

default Set<com.palantir.suppressibleerrorprone.transform.ModifiedFile> getModifiedFiles()

combine

static ModifyCheckApiOption.CombinedValue combine(Collection<ModifyCheckApiOption> options)