Annotation Interface MaybeIteratorPolyMod
@Documented
@Retention(RUNTIME)
@Target({TYPE_USE,TYPE_PARAMETER})
@SubtypeOf({})
@DefaultQualifierInHierarchy
public @interface MaybeIteratorPolyMod
The top qualifier in the Iterator hierarchy. The iterator of the annotated collection is not
known to preserve the collection's capabilities, so the result of
iterator() and
listIterator() does not acquire a capability from the collection: it is the top qualifier in
every capability hierarchy -- @MaybeShrinkable, and for a ListIterator also
@MaybeGrowable and @MaybeReplaceable.
The iterator does inherit the collection's lack of a capability, since a collection
that cannot be modified has no iterator that can modify it. For example, an
@Unshrinkable @MaybeIteratorPolyMod collection has an @Unshrinkable iterator.
This is the default qualifier for unannotated types.
- See Also:
- See the Checker Framework Manual:
- Modifiability Checker