@Beta
public abstract class IssueRegistry
extends java.lang.Object
NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.
Modifier and Type | Field and Description |
---|---|
static Issue |
BASELINE
Issue reported by lint for various other issues which prevents lint from
running normally when it's not necessarily an error in the user's code base.
|
static Issue |
CANCELLED
Issue reported when lint is canceled
|
static Issue |
LINT_ERROR
Issue reported by lint for various other issues which prevents lint from
running normally when it's not necessarily an error in the user's code base.
|
static Issue |
PARSER_ERROR
Issue reported by lint (not a specific detector) when it cannot even
parse an XML file prior to analysis
|
Modifier | Constructor and Description |
---|---|
protected |
IssueRegistry()
Creates a new IssueRegistry
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Category> |
getCategories()
Returns the available categories
|
Issue |
getIssue(java.lang.String id)
Returns the issue for the given id, or null if it's not a valid id
|
protected int |
getIssueCapacity(java.util.EnumSet<Scope> scope)
Get an approximate issue count for a given scope.
|
abstract java.util.List<Issue> |
getIssues()
Returns the list of issues that can be found by all known detectors.
|
protected java.util.List<Issue> |
getIssuesForScope(java.util.EnumSet<Scope> scope)
Returns all available issues of a given scope (regardless of whether
they are actually enabled for a given configuration etc)
|
boolean |
isCategoryName(java.lang.String name)
Returns true if the given category is a valid category
|
boolean |
isIssueId(java.lang.String id)
Returns true if the given id represents a valid issue id
|
boolean |
isUpToDate()
Whether this issue registry is up to date.
|
protected static void |
reset()
Reset the registry such that it recomputes its available issues.
|
@NonNull public static final Issue PARSER_ERROR
@NonNull public static final Issue LINT_ERROR
@NonNull public static final Issue CANCELLED
@NonNull public static final Issue BASELINE
protected IssueRegistry()
@NonNull public abstract java.util.List<Issue> getIssues()
protected int getIssueCapacity(@NonNull java.util.EnumSet<Scope> scope)
scope
- the scope set@NonNull protected java.util.List<Issue> getIssuesForScope(@NonNull java.util.EnumSet<Scope> scope)
scope
- the applicable scope setpublic final boolean isIssueId(@NonNull java.lang.String id)
id
- the id to be checkedpublic final boolean isCategoryName(@NonNull java.lang.String name)
name
- the category name to be checked@NonNull public java.util.List<Category> getCategories()
@Nullable public final Issue getIssue(@NonNull java.lang.String id)
id
- the id to be checkedpublic boolean isUpToDate()
protected static void reset()