com.github.akurilov.commons.io.Input Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-commons Show documentation

Common functionality Java library

There is a newer version: 2.3.6

package com.github.akurilov.commons.io;

import java.io.Closeable;
import java.io.EOFException;
import java.io.IOException;
import java.util.List;

/**
 * The Java objects input supporting the batch calls
 */
public interface Input
extends Closeable {

	String DELIMITER = ";";

	/**
	 Get next item
	 @return next item or null if no items available more
	 @throws java.io.EOFException if no item available more
	 @throws java.io.IOException if failed to get some-why
	 */
	I get()
	throws EOFException, IOException;

	/**
	 Bulk items get.
	 @param buffer buffer for the items
	 @param limit max count of the items to put into the buffer
	 @return count of the items have been get and put into the buffer actually
	 @throws java.io.EOFException if no item available more
	 @throws java.io.IOException if failed to get some-why
	 */
	int get(final List buffer, final int limit)
	throws IOException;
	
	/**
	 Bulk items get method useful for remote invocation.
	 @return the items, null if the method is disabled
	 @throws EOFException if not items available more
	 @throws IOException if failed to get for some reason
	 */
	default List getAll()
	throws IOException {
		return null;
	}
	
	/**
	 * Skip some items.
	 * @param count count of items should be skipped from the input stream
	 * @throws IOException if failed to skip such amount of bytes
	 */
	long skip(final long count)
	throws IOException;
	
	/**
	 Reset this input making this readable from the beginning
	 */
	void reset()
	throws IOException;
}