org.eclipse.collections.impl.EmptyIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections Show documentation

There is a newer version: 12.0.0.M3

/*
 * Copyright (c) 2016 Goldman Sachs.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.impl;

import java.util.ListIterator;
import java.util.NoSuchElementException;

import net.jcip.annotations.Immutable;

/**
 * A Singleton iterator which is empty and can be used by all empty collections.
 */
@Immutable
public final class EmptyIterator
        implements ListIterator
{
    private static final EmptyIterator INSTANCE = new EmptyIterator<>();

    private EmptyIterator()
    {
    }

    public static  EmptyIterator getInstance()
    {
        return (EmptyIterator) INSTANCE;
    }

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

    @Override
    public T next()
    {
        throw new NoSuchElementException();
    }

    @Override
    public void remove()
    {
        throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
    }

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

    @Override
    public T previous()
    {
        throw new NoSuchElementException();
    }

    @Override
    public int nextIndex()
    {
        return 0;
    }

    @Override
    public int previousIndex()
    {
        return -1;
    }

    @Override
    public void set(T t)
    {
        throw new UnsupportedOperationException("Cannot call set() on " + this.getClass().getSimpleName());
    }

    @Override
    public void add(T t)
    {
        throw new UnsupportedOperationException("Cannot call add() on " + this.getClass().getSimpleName());
    }
}