org.basex.io.in

Class BufferInput

java.lang.Object

java.io.InputStream

org.basex.io.in.BufferInput

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ArrayInput, DataInput, TextInput

public class BufferInput
extends java.io.InputStream

This class uses an internal buffer to speed up input stream processing.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor and Description
BufferInput(java.io.InputStream is) Constructor.
BufferInput(java.io.InputStream is, int bs) Initializes the file reader.
BufferInput(IO io) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
byte[]	content() Retrieves and returns the whole text and closes the stream.
long	length() Returns the input length.
BufferInput	length(long l) Sets the input length.
void	mark(int m)
boolean	markSupported()
protected int	next() Returns the next byte (see InputStream.read().
int	read() Returns the next byte (see InputStream.read().
byte[]	readBytes() Reads a byte array from the input stream, suffixed by a 0 byte.
java.lang.String	readString() Reads a string from the input stream, suffixed by a 0 byte.
void	reset()
int	size() Returns the number of read bytes.

Methods inherited from class java.io.InputStream

available, read, read, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferInput

public BufferInput(IO io)
            throws java.io.IOException

Constructor.

Parameters:

io - input to be read

Throws:

java.io.IOException - I/O Exception

BufferInput

public BufferInput(java.io.InputStream is)

Constructor.

Parameters:

is - input stream

BufferInput

public BufferInput(java.io.InputStream is,
           int bs)

Initializes the file reader.

Parameters:

is - input stream

bs - buffer size

Method Detail

read

public int read()
         throws java.io.IOException

Returns the next byte (see InputStream.read(). -1 is returned if all bytes have been read.

Specified by:

read in class java.io.InputStream

Returns:

next byte

Throws:

java.io.IOException - I/O exception

next

protected int next()
            throws java.io.IOException

Returns the next byte (see InputStream.read(). -1 is returned if all bytes have been read.

Returns:

next byte

Throws:

java.io.IOException - I/O exception

readString

public final java.lang.String readString()
                                  throws java.io.IOException

Reads a string from the input stream, suffixed by a 0 byte.

Returns:

string

Throws:

java.io.IOException - I/O Exception

readBytes

public final byte[] readBytes()
                       throws java.io.IOException

Reads a byte array from the input stream, suffixed by a 0 byte.

Returns:

token

Throws:

java.io.IOException - I/O Exception

close

public final void close()
                 throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

size

public final int size()

Returns the number of read bytes.

Returns:

read bytes

length

public final long length()

Returns the input length.

Returns:

input length

length

public final BufferInput length(long l)

Sets the input length.

Parameters:

l - input length

Returns:

self reference

markSupported

public final boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

mark

public void mark(int m)

Overrides:

mark in class java.io.InputStream

reset

public final void reset()
                 throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

content

public byte[] content()
               throws java.io.IOException

Retrieves and returns the whole text and closes the stream.

Returns:

contents

Throws:

java.io.IOException - I/O exception