org.xbib.io.ftp.fs.AbstractDirectoryStream Maven / Gradle / Ivy

Go to download
package org.xbib.io.ftp.fs;

import java.io.IOException;
import java.nio.file.DirectoryIteratorException;
import java.nio.file.DirectoryStream;
import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * This class provides a skeletal implementation of the {@link DirectoryStream} interface to minimize the effort
 * required to implement this interface.
 * It will take care of ending iteration when the stream is closed, and making sure that {@link #iterator()}
 * is only called once.
 * Subclasses often only need to implement {@link #getNext()}. Optionally, if they need perform setup steps before
 * iteration, they should override
 * {@link #setupIteration()} as well.
 *
 * @param  The type of element returned by the iterator.
 */
public abstract class AbstractDirectoryStream implements DirectoryStream {

    private final Filter filter;

    private boolean open = true;
    private Iterator iterator = null;

    /**
     * Creates a new {@code DirectoryStream}.
     *
     * @param filter The optional filter to use.
     */
    public AbstractDirectoryStream(Filter filter) {
        this.filter = filter;
    }

    @Override
    public synchronized void close() throws IOException {
        open = false;
    }

    private synchronized boolean isOpen() {
        return open;
    }

    @Override
    public synchronized Iterator iterator() {
        if (!open) {
            throw Messages.directoryStream().closed();
        }
        if (iterator != null) {
            throw Messages.directoryStream().iteratorAlreadyReturned();
        }
        iterator = new Iterator() {
            private T next = null;
            private State state = State.UNSPECIFIED;

            @Override
            public boolean hasNext() {
                if (state == State.UNSPECIFIED) {
                    next = getNextElement();
                    state = next != null ? State.ACTIVE : State.ENDED;
                }
                return state == State.ACTIVE;
            }

            @Override
            public T next() {
                if (!hasNext()) {
                    throw new NoSuchElementException();
                }
                T result = next;
                next = null;
                state = State.UNSPECIFIED;
                return result;
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
        setupIteration();
        return iterator;
    }

    private T getNextElement() {
        while (isOpen()) {
            try {
                T next = getNext();
                if (next == null) {
                    return null;
                }
                if (filter == null || filter.accept(next)) {
                    return next;
                }
            } catch (IOException e) {
                throw new DirectoryIteratorException(e);
            }
        }
        return null;
    }

    /**
     * Performs the necessary steps to setup iteration. The default implementation does nothing.
     */
    protected void setupIteration() {
        // does nothing
    }

    /**
     * Returns the next element in iteration.
     *
     * @return The next element in iteration, or {@code null} if there is no more next element.
     * @throws IOException If the next element could not be retrieved.
     */
    protected abstract T getNext() throws IOException;

    private enum State {
        /**
         * Indicates a lookahead iterator is still active (i.e. there is a next element).
         */
        ACTIVE,
        /**
         * Indicates a lookahead iterator has ended (i.e. there is no next element).
         */
        ENDED,
        /**
         * Indicates it's not known whether or not a lookahead iterator has a next element or not.
         */
        UNSPECIFIED,
    }
}