Modifier and Type	Class and Description
public static class	BomInput.BytesProcessedNotification Internal notification exception used to re-wrap the original `InputStream` into a `Reader`.

Field Summary

Modifier and Type	Field and Description
private int[]	bytes
private int	bytesRead
private int	consumed
private String	encoding
private IOException	exception
private final InputStream	input
public static final byte[]	UTF_16BE_BOM
public static final byte[]	UTF_16LE_BOM
public static final byte[]	UTF_32BE_BOM
public static final byte[]	UTF_32LE_BOM
public static final byte[]	UTF_8_BOM

Constructor Summary

Access	Constructor and Description
public	BomInput(InputStream the input whose first bytes should be analyzed. input) Wraps an `InputStream` and reads the first bytes found on it to attempt to read a BOM.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public final Charset	Returns: the detected `Charset` or `null` if a BOM could not be matched. getCharset() Returns the detected `Charset` determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class.
public final String	Returns: the detected encoding name or `null` if a BOM could not be matched. getEncoding() Returns the detected encoding name determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class.
public final boolean	Returns: `false` if there are no bytes stored and the original input stream can be used directly. If this wrapper needs to be used to return stored bytes before, then `true` will be returned. hasBytesStored() Returns a flag indicating whether or not all bytes read from the wrapped input stream have been consumed.
private int	next()
public final int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
private void	setEncoding(String encoding)

Inherited from java.io.InputStream:: available mark markSupported nullInputStream read read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

bytes	back to summary
private int[] bytes

bytesRead	back to summary
private int bytesRead

consumed	back to summary
private int consumed

encoding	back to summary
private String encoding

exception	back to summary
private IOException exception

input	back to summary
private final InputStream input

UTF_16BE_BOM	back to summary
public static final byte[] UTF_16BE_BOM

UTF_16LE_BOM	back to summary
public static final byte[] UTF_16LE_BOM

UTF_32BE_BOM	back to summary
public static final byte[] UTF_32BE_BOM

UTF_32LE_BOM	back to summary
public static final byte[] UTF_32LE_BOM

UTF_8_BOM	back to summary
public static final byte[] UTF_8_BOM

Constructor Detail

BomInput back to summary

BomInput	back to summary
public BomInput(InputStream input) Wraps an `InputStream` and reads the first bytes found on it to attempt to read a BOM. Parameters input:InputStream the input whose first bytes should be analyzed.

public BomInput(InputStream input)

Wraps an InputStream and reads the first bytes found on it to attempt to read a BOM.

Parameters

input:InputStream: the input whose first bytes should be analyzed.

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getCharset back to summary

getCharset	back to summary
public final Charset getCharset() Returns the detected `Charset` determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class. If no BOM was detected, this method will return `null`. Returns:Charset the detected `Charset` or `null` if a BOM could not be matched.

public final Charset getCharset()

Returns the detected Charset determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class. If no BOM was detected, this method will return null.

Returns:Charset: the detected Charset or null if a BOM could not be matched.

getEncoding back to summary

getEncoding	back to summary
public final String getEncoding() Returns the detected encoding name determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class. If no BOM was detected, this method will return `null`. Returns:String the detected encoding name or `null` if a BOM could not be matched.

public final String getEncoding()

Returns the detected encoding name determined by the Byte Order Mark (BOM) available in the input provided in the constructor of this class. If no BOM was detected, this method will return null.

Returns:String: the detected encoding name or null if a BOM could not be matched.

hasBytesStored back to summary

hasBytesStored	back to summary
public final boolean hasBytesStored() Returns a flag indicating whether or not all bytes read from the wrapped input stream have been consumed. This allows client code to determine if the original input stream can be used directly and safely, or if this `BomInput` wrapper class should be used instead. If there are stored bytes that need to be consumed before the wrapped input stream is consumed again, this method will return `true`. Returns:boolean `false` if there are no bytes stored and the original input stream can be used directly. If this wrapper needs to be used to return stored bytes before, then `true` will be returned.

public final boolean hasBytesStored()

Returns a flag indicating whether or not all bytes read from the wrapped input stream have been consumed. This allows client code to determine if the original input stream can be used directly and safely, or if this BomInput wrapper class should be used instead. If there are stored bytes that need to be consumed before the wrapped input stream is consumed again, this method will return true.

Returns:boolean: false if there are no bytes stored and the original input stream can be used directly. If this wrapper needs to be used to return stored bytes before, then true will be returned.

next	back to summary
private int next() throws IOException

read back to summary

read	back to summary
public final int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public final int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

setEncoding	back to summary
private void setEncoding(String encoding)

com.univocity.parsers.common.input back to summary

public final Class BomInput.BytesProcessedNotification

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.univocity.parsers.common.input.BomInput.BytesProcessedNotification

Internal notification exception used to re-wrap the original InputStream into a Reader. This is required for performance reasons as overriding InputStream#read() incurs a heavy performance penalty when the implementation is native (as in FileInputStream#read().

Field Summary

Modifier and Type	Field and Description
public final String	encoding
public final InputStream	input

Constructor Summary

Access	Constructor and Description
public	BytesProcessedNotification(InputStream input, String encoding)

Method Summary

Modifier and Type	Method and Description
public Throwable	fillInStackTrace() Overrides java.lang.Throwable.fillInStackTrace. Fills in the execution stack trace.

Field Detail

encoding	back to summary
public final String encoding

input	back to summary
public final InputStream input

Constructor Detail

BytesProcessedNotification	back to summary
public BytesProcessedNotification(InputStream input, String encoding)

Method Detail

fillInStackTrace back to summary

fillInStackTrace	back to summary
public Throwable fillInStackTrace() Overrides java.lang.Throwable.fillInStackTrace. Doc from java.lang.Throwable.fillInStackTrace. Fills in the execution stack trace. This method records within this `Throwable` object information about the current state of the stack frames for the current thread. If the stack trace of this `Throwable` is not writable, calling this method has no effect. Returns:Throwable a reference to this `Throwable` instance. Annotations @Override

public Throwable fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Doc from java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace. This method records within this Throwable object information about the current state of the stack frames for the current thread.

If the stack trace of this Throwable is not writable, calling this method has no effect.

Returns:Throwable

a reference to this Throwable instance.

Annotations

@Override

public final Class BomInput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BomInput.BytesProcessedNotification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail