Package org.kohsuke.stapler.framework.io

Interface LargeText.Session

All Superinterfaces:

AutoCloseable, Closeable

Enclosing class:

LargeText

public static interface LargeText.Session
extends Closeable

Represents the read session of the LargeText.Source. Methods follow the contracts of InputStream.

Method Summary

Modifier and Type	Method	Description
int	read(byte[] buf)	See also InputStream.read(byte[]).
int	read(byte[] buf, int offset, int length)	See also InputStream.read(byte[], int, int).
long	skip(long n)	See also InputStream.skip(long).

Methods inherited from interface java.io.Closeable

close

Method Details

skip

long skip(long n)
   throws IOException

See also InputStream.skip(long).

Parameters:

n - Number of bytes to skip ahead.

Returns:

Number of bytes that were skipped.

Throws:

IOException - if an error occurs. Skipping less than n bytes does not need to throw.

read

int read(byte[] buf)
  throws IOException

See also InputStream.read(byte[]).

Parameters:

buf - Buffer to fill.

Returns:

Number of bytes that were filled.

Throws:

IOException - if an error occurs.

read

int read(byte[] buf,
 int offset,
 int length)
  throws IOException

See also InputStream.read(byte[], int, int).

Parameters:

buf - Buffer to fill.

offset - Number of bytes to skip in buf.

length - Number of bytes to read at most.

Returns:

Number of bytes that were read.

Throws:

IOException - if an error occurs.