uk.ac.starlink.table.EmptyRowSequence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stil Show documentation

Starlink Tables Infrastructure Library

There is a newer version: 4.3

package uk.ac.starlink.table;

import java.util.function.LongSupplier;

/**
 * Implementation of both RowSequence and RowAccess which has no rows.
 * Singleton class.
 * 
 * @since    28 Oct 2004
 * @author   Mark Taylor (Starlink)
 */
public class EmptyRowSequence implements RowSplittable, RowAccess {

    /** Instance. */
    private static final EmptyRowSequence INSTANCE = new EmptyRowSequence();

    /**
     * Private constructor prevents instantiation.
     */
    private EmptyRowSequence() {
    }

    /**
     * Always returns false.
     */
    public boolean next() {
        return false;
    }

    public void setRowIndex( long irow ) {
        throw new IllegalArgumentException( "Out of bounds (no data)" );
    }

    public LongSupplier rowIndex() {
        return () -> -1L;
    }

    public RowSplittable split() {
        return null;
    }

    public long splittableSize() {
        return 0;
    }

    /**
     * Always throws IllegalStateException.
     */
    public Object getCell( int icol ) {
        throw new IllegalStateException();
    }

    /**
     * Always throws IllegalStateException.
     */
    public Object[] getRow() {
        throw new IllegalStateException();
    }

    /**
     * Does nothing.
     */
    public void close() {
    }

    /**
     * Returns singleton instance of this class.
     *
     * @return   instance
     */
    public static EmptyRowSequence getInstance() {
        return INSTANCE;
    }
}