ProgressIterator (worldedit-core 7.2.0 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.sk89q.worldedit.util.task.progress.ProgressIterator<V>

Type Parameters:

V - the type

All Implemented Interfaces:

ProgressObservable, java.util.Iterator<V>
```
public class ProgressIterator<V>
extends java.lang.Object
implements java.util.Iterator<V>, ProgressObservable
```
An iterator that keeps track of how many entries have been visited and calculates a "percent completed" using a provided total count.
The returned progress percentage will always be between 0 or 1 (inclusive). If the iterator returns more entries than the total count, then 100% will be returned for the progress.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <V> ProgressIterator<V>`	`create(java.util.Iterator<V> iterator, int count)` Create a new instance.
`static <V> ProgressIterator<V>`	`create(java.util.List<V> list)` Create a new instance from a list.
`Progress`	`getProgress()` Get the current percentage of completion.
`boolean`	`hasNext()`
`V`	`next()`
`void`	`remove()`

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface java.util.Iterator<V>
  - next
```
public V next()
```
    Specified by:
    
    next in interface java.util.Iterator<V>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<V>
  - getProgress
```
public Progress getProgress()
```
    Description copied from interface: ProgressObservable
    
    Get the current percentage of completion.
    
    Specified by:
    
    getProgress in interface ProgressObservable
    
    Returns:
    
    a progress object
  - create
```
public static <V> ProgressIterator<V> create(java.util.Iterator<V> iterator,
                                             int count)
```
    Create a new instance.
    
    Type Parameters:
    
    V - the type
    
    Parameters:
    
    iterator - the iterator
    
    count - the number of objects
    
    Returns:
    
    an instance
  - create
```
public static <V> ProgressIterator<V> create(java.util.List<V> list)
```
    Create a new instance from a list.
    
    Type Parameters:
    
    V - the type
    
    Parameters:
    
    list - a list
    
    Returns:
    
    an instance

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method