com.swirlds.common.utility.UnmodifiableIterator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation
Show all versions of swirlds-common Show documentation
Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.
/*
* Copyright (C) 2018-2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.swirlds.common.utility;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Iterator;
import java.util.Objects;
import java.util.function.Consumer;
/**
* This class can be used to wrap an iterator that is modifiable to make it unmodifiable.
*
* @param
* the type of the object that the iterator walks over
*/
public class UnmodifiableIterator implements Iterator {
private final Iterator baseIterator;
public UnmodifiableIterator(@NonNull final Iterator baseIterator) {
Objects.requireNonNull(baseIterator, "baseIterator must not be null");
this.baseIterator = baseIterator;
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasNext() {
return baseIterator.hasNext();
}
/**
* {@inheritDoc}
*/
@Override
public T next() {
return baseIterator.next();
}
/**
* Not supported.
*
* @throws UnsupportedOperationException
* if called
*/
@Override
public void remove() {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*/
@Override
public void forEachRemaining(final Consumer action) {
baseIterator.forEachRemaining(action);
}
}