org.chocosolver.util.iterators

Class Disposable

java.lang.Object

org.chocosolver.util.iterators.Disposable

Direct Known Subclasses:

DisposableIntIterator, DisposableRangeIterator, DisposableValueIterator

public abstract class Disposable
extends Object

Since:

05/10/11

Author:

Charles Prud'homme

Constructor Summary

Constructors

Constructor and Description
Disposable()

Method Summary

Modifier and Type	Method and Description
void	dispose() This method allows to declare that the iterator is not used anymoure.
void	init() Freeze the iterator, cannot be reused.
boolean	isNotReusable()
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Disposable

public Disposable()

Method Detail

init

public void init()

Freeze the iterator, cannot be reused.

dispose

public void dispose()

This method allows to declare that the iterator is not used anymoure. It can be reused by another object.

remove

public void remove()

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Throws:

UnsupportedOperationException - if the remove operation is not supported by this Iterator.

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

isNotReusable

public final boolean isNotReusable()

Returns:

true if the iterator is not free for use (you should create a new instance)