Package org.basex.io.in

Class NewlineInput

java.lang.Object

java.io.InputStream

org.basex.io.in.BufferInput

org.basex.io.in.TextInput

org.basex.io.in.NewlineInput

All Implemented Interfaces:

Closeable, AutoCloseable

public final class NewlineInput
extends TextInput

This class provides a convenient access to text input. System dependent line breaks (\r\n, \n, \r) will be normalized to newline characters \n, and the input encoding will be guessed by analyzing the first bytes.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor	Description
NewlineInput(byte[] token)	Constructor.
NewlineInput(InputStream is)	Constructor.
NewlineInput(IO in)	Constructor.

Method Summary

Modifier and Type	Method	Description
NewlineInput	encoding(String encoding)	Sets a new encoding.
int	read()	Returns the next codepoint.
String	readLine()	Reads and returns a single line.
boolean	readLine(TokenBuilder tb)	Copies a single line to the specified token builder.

Methods inherited from class org.basex.io.in.TextInput

cache, content, encoding, validate

Methods inherited from class org.basex.io.in.BufferInput

close, get, get, io, length, mark, markSupported, readBytes, readString, reset, size

Methods inherited from class java.io.InputStream

available, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

NewlineInput

public NewlineInput(InputStream is)
             throws IOException

Constructor.

Parameters:

is - input stream

Throws:

IOException - I/O exception

NewlineInput

public NewlineInput(IO in)
             throws IOException

Constructor.

Parameters:

in - input

Throws:

IOException - I/O exception

NewlineInput

public NewlineInput(byte[] token)
             throws IOException

Constructor.

Parameters:

token - token

Throws:

IOException - I/O exception

Method Details

encoding

public NewlineInput encoding(String encoding)
                      throws IOException

Description copied from class: TextInput

Sets a new encoding.

Overrides:

encoding in class TextInput

Parameters:

encoding - encoding (ignored if null or an empty string)

Returns:

self reference

Throws:

IOException - I/O Exception

read

public int read()
         throws IOException

Description copied from class: TextInput

Returns the next codepoint.

Overrides:

read in class TextInput

Returns:

next codepoint

Throws:

IOException - I/O exception

readLine

public String readLine()
                throws IOException

Reads and returns a single line.

Returns:

line or null

Throws:

IOException - I/O exception

readLine

public boolean readLine(TokenBuilder tb)
                 throws IOException

Copies a single line to the specified token builder.

Parameters:

tb - token builder to be filled

Returns:

true if more input was found

Throws:

IOException - I/O exception