com.github.akurilov.commons.io

Interface Input<I>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

FileInput<T>, IoBuffer<T>

All Known Implementing Classes:

ArrayInput, BinFileInput, BinInput, BufferingInputBase, CircularArrayInput, CircularListInput, LimitedQueueBuffer, ListInput, TextFileInput, TextStreamInput

public interface Input<I>
extends java.io.Closeable

The Java objects input supporting the batch calls

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIMITER

Method Summary

Modifier and Type	Method and Description
I	get() Get next item
int	get(java.util.List<I> buffer, int limit) Bulk items get.
default java.util.List<I>	getAll() Bulk items get method useful for remote invocation.
void	reset() Reset this input making this readable from the beginning
long	skip(long count) Skip some items.

Methods inherited from interface java.io.Closeable

close

Field Detail

DELIMITER

static final java.lang.String DELIMITER

See Also:

Constant Field Values

Method Detail

get

I get()
throws java.io.EOFException,
      java.io.IOException

Get next item

Returns:

next item or null if no items available more

Throws:

java.io.EOFException - if no item available more

java.io.IOException - if failed to get some-why

get

int get(java.util.List<I> buffer,
        int limit)
 throws java.io.IOException

Bulk items get.

Parameters:

buffer - buffer for the items

limit - max count of the items to put into the buffer

Returns:

count of the items have been get and put into the buffer actually

Throws:

java.io.EOFException - if no item available more

java.io.IOException - if failed to get some-why

getAll

default java.util.List<I> getAll()
                          throws java.io.IOException

Bulk items get method useful for remote invocation.

Returns:

the items, null if the method is disabled

Throws:

java.io.EOFException - if not items available more

java.io.IOException - if failed to get for some reason

skip

long skip(long count)
   throws java.io.IOException

Skip some items.

Parameters:

count - count of items should be skipped from the input stream

Throws:

java.io.IOException - if failed to skip such amount of bytes

reset

void reset()
    throws java.io.IOException

Reset this input making this readable from the beginning

Throws:

java.io.IOException