public interface TypeEnvironment
ProcessingEnvironment
and
serves the same purpose. To give a context to the API checking classes.Modifier and Type | Method and Description |
---|---|
Elements |
getElementUtils() |
Types |
getTypeUtils() |
boolean |
isExplicitlyExcluded(Element element)
This returns true for elements that are excluded by the means of configuration.
|
boolean |
isExplicitlyIncluded(Element element)
This returns true for elements that are included by the means of configuration.
|
@Nonnull Elements getElementUtils()
Elements
@Nonnull Types getTypeUtils()
Types
boolean isExplicitlyIncluded(Element element)
Note that this is not a mere opposite of isExplicitlyExcluded(Element)
. Both methods can return false
for a single element, which means that the inclusion state of that element is implicit. Usually this means that
the inclusion is dependent on the parent element.
element
- the element to checkboolean isExplicitlyExcluded(Element element)
It does not mean that the element is to be included in the API checks if this method returns false. That merely
means that the user didn't explicitly exclude it and further checks need to be made to establish whether to check
the element or not (see for example CheckBase.isAccessible(JavaModelElement)
).
element
- the element to check (might be type, method, whatever)Copyright © 2014-2020 Lukas Krejci. All Rights Reserved.