/* ###
 * IP: GHIDRA
 *
 * 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 ghidra.program.model.sourcemap;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * Interface for iterating over {@link SourceMapEntry}s. 
 */
public interface SourceMapEntryIterator extends Iterator<SourceMapEntry>, Iterable<SourceMapEntry> {

	public static final SourceMapEntryIterator EMPTY_ITERATOR = new SourceMapEntryIterator() {

		@Override
		public Iterator<SourceMapEntry> iterator() {
			return this;
		}

		@Override
		public SourceMapEntry next() {
			throw new NoSuchElementException("Empty iterator is empty!");
		}

		@Override
		public boolean hasNext() {
			return false;
		}
	};

}
