org.leialearns.bridge.NearIterable Maven / Gradle / Ivy

Go to download

package org.leialearns.bridge;

/**
 * Provides an iterable with a few convenience methods.
 * @param  The type of objects returned by the iterator
 */
public interface NearIterable extends DeclaresNearType, Iterable {
    /**
     * Returns the first object of this iterable; or null if the iterable is empty.
     * @return The first object of this iterable; or null if the iterable is empty
     */
    NT first();

    /**
     * Returns an flag that indicates whether the iterable is empty.
     * @return true if the iterable is empty; false otherwise
     */
    boolean isEmpty();
}