AbiFiltersSpec

A set of filtering rules that restrict Application Binary Interface (ABI) declarations from being included in a dump.

The rules combine inclusion and exclusion of declarations. Each filter can be written as either a class name filter (see AbiFilterSetSpec.byNames) or an annotation filter (see AbiFilterSetSpec.annotatedWith).

filters {
    exclude {
        byNames.add("foo.Bar")
        annotatedWith.add("foo.ExcludeAbi")
    }

    include {
        byNames.add("foo.api.**")
        annotatedWith.add("foo.PublicApi")
    }
}

In order for a declaration (class, field, property, or function) to be included in the dump, it must pass all inclusion and exclusion filters.

A declaration successfully passes the exclusion filter if it does not match any of the class name (see AbiFilterSetSpec.byNames) or annotation (see AbiFilterSetSpec.annotatedWith) filter rules.

A declaration successfully passes the inclusion filter if no inclusion rules exist, if it matches any inclusion rule, or if at least one of its members (relevant for class declaration) matches any inclusion rule.