IteratorDeclaration (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.util.IterableTraversal
- - com.intellij.codeInspection.util.IteratorDeclaration

```
public class IteratorDeclaration
extends IterableTraversal
```
Represents the iterator which traverses the iterable within the loop

Field Summary
- Fields inherited from class com.intellij.codeInspection.util.IterableTraversal
  myCollection, myIterable

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PsiElement`	`findOnlyIteratorRef(PsiExpression parent)`
`static IteratorDeclaration`	`fromLoop(PsiLoopStatement statement)` Creates `IteratorDeclaration` if the loop follows one of these patterns:
`PsiLocalVariable`	`getIterator()`
`PsiVariable`	`getNextElementVariable(PsiStatement statement)`
`boolean`	`isHasNextCall(PsiExpression condition)`
`boolean`	`isIteratorMethodCall(PsiElement candidate, java.lang.String method)`
`boolean`	`isRemoveCall(PsiExpression candidate)`

Methods inherited from class com.intellij.codeInspection.util.IterableTraversal
getIterable, isCollection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public boolean isHasNextCall(PsiExpression condition)

public PsiElement findOnlyIteratorRef(PsiExpression parent)

public boolean isIteratorMethodCall(PsiElement candidate,
                                    java.lang.String method)

public PsiVariable getNextElementVariable(PsiStatement statement)

public static IteratorDeclaration fromLoop(PsiLoopStatement statement)

Creates IteratorDeclaration if the loop follows one of these patterns:


 Iterator<T> it = iterable.iterator();
 while(it.hasNext()) {
   ...
 }
 // And iterator is not reused after the loop


 for(Iterator<T> it = iterable.iterator();it.hasNext();) {
   ...
 }

Parameters:: statement - loop to create the IteratorDeclaration from
Returns:: created IteratorDeclaration or null if the loop pattern is not recognized.

Class IteratorDeclaration