Skip to content

Commit 64521b6

Browse files
committed
Polish microsphere-projects#161 : Update JavaDoc
1 parent 73493f4 commit 64521b6

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

microsphere-java-core/src/main/java/io/microsphere/collection/UnmodifiableIterator.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,15 @@
2020
import java.util.function.Consumer;
2121

2222
/**
23-
* Unmodifiable {@link Iterator}
23+
* An {@link Iterator} that cannot be modified. This class wraps a given iterator and ensures that any attempt to modify the
24+
* underlying data structure via the iterator is prevented by throwing an {@link UnsupportedOperationException}.
25+
*
26+
* <p>This implementation inherits the read-only behavior from its parent class, which disables the use of the
27+
* {@link Iterator#remove()} method.
2428
*
2529
* @param <E> the type of elements returned by this iterator
2630
* @author <a href="mailto:mercyblitz@gmail.com">Mercy</a>
31+
* @see ReadOnlyIterator
2732
* @since 1.0.0
2833
*/
2934
public class UnmodifiableIterator<E> extends ReadOnlyIterator<E> {

0 commit comments

Comments
 (0)