univocity-parsers 2.9.1 · com.univocity.parsers.common.input.concurrent.ConcurrentCharInputReader

A concurrent CharInputReader that loads batches of characters in a separate thread and assigns them to buffer in AbstractCharInputReader when requested.

This class loads "buckets" of characters in the background and provides them sequentially to the ConcurrentCharInputReader#buffer attribute in AbstractCharInputReader.

The bucket loading process will block and wait while all buckets are full.

Similarly, the reader will block while all buckets are empty. This CharInputReader implementation provides a better throughput than DefaultCharInputReader when reading large inputs (> 100 mb).

Field Summary

Modifier and Type	Field and Description
private ConcurrentCharLoader	bucketLoader
private final int	bucketQuantity
private final int	bucketSize
private boolean	unwrapping

Inherited from com.univocity.parsers.common.input.AbstractCharInputReader:: buffer closeOnStop i length

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ConcurrentCharInputReader(char the normalized newline character (as defined in `Format#getNormalizedNewline()`) that is used to replace any lineSeparator sequence found in the input. normalizedLineSeparator, int the size of an each individual "bucket" used to store characters read from the input. bucketSize, int the number of "buckets" to load in memory. Note the reader will stop if all buckets are full. bucketQuantity, int starting range of characters considered to be whitespace. whitespaceRangeStart, boolean indicates whether to automatically close the input when `stop()` is called closeOnStop) Creates a new instance with the mandatory characters for handling newlines transparently.
public	ConcurrentCharInputReader(char[] the sequence of characters that represent a newline, as defined in `Format#getLineSeparator()` lineSeparator, char the normalized newline character (as defined in `Format#getNormalizedNewline()`) that is used to replace any lineSeparator sequence found in the input. normalizedLineSeparator, int the size of an each individual "bucket" used to store characters read from the input. bucketSize, int the number of "buckets" to load in memory. Note the reader will stop if all buckets are full. bucketQuantity, int starting range of characters considered to be whitespace. whitespaceRangeStart, boolean indicates whether to automatically close the input when `stop()` is called closeOnStop) Creates a new instance with the mandatory characters for handling newlines transparently.

public

ConcurrentCharInputReader(char

the normalized newline character (as defined in Format#getNormalizedNewline()) that is used to replace any lineSeparator sequence found in the input.

normalizedLineSeparator, int

the size of an each individual "bucket" used to store characters read from the input.

bucketSize, int

the number of "buckets" to load in memory. Note the reader will stop if all buckets are full.

bucketQuantity, int

starting range of characters considered to be whitespace.

whitespaceRangeStart, boolean

indicates whether to automatically close the input when stop() is called

closeOnStop)

Creates a new instance with the mandatory characters for handling newlines transparently.

public

ConcurrentCharInputReader(char[]

the sequence of characters that represent a newline, as defined in Format#getLineSeparator()

lineSeparator, char

the normalized newline character (as defined in Format#getNormalizedNewline()) that is used to replace any lineSeparator sequence found in the input.

normalizedLineSeparator, int

the size of an each individual "bucket" used to store characters read from the input.

bucketSize, int

the number of "buckets" to load in memory. Note the reader will stop if all buckets are full.

bucketQuantity, int

starting range of characters considered to be whitespace.

whitespaceRangeStart, boolean

indicates whether to automatically close the input when stop() is called

closeOnStop)

Creates a new instance with the mandatory characters for handling newlines transparently.

Method Summary

Modifier and Type	Method and Description
protected void	reloadBuffer() Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.reloadBuffer. Assigns the next "bucket" of characters to the `ConcurrentCharInputReader#buffer` attribute, and updates the `ConcurrentCharInputReader#length` to the number of characters read.
protected void	setReader(Reader the `java.io.Reader` provided in `AbstractCharInputReader#start(Reader)` reader) Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.setReader. Starts an input reading thread to load characters from the given reader into "buckets" of characters
public void	stop() Implements com.univocity.parsers.common.input.CharInputReader.stop. Stops the CharInputReader from reading characters from the `java.io.Reader` provided in `ConcurrentCharInputReader#start(Reader)` and closes it.

Field Detail

bucketLoader	back to summary
private ConcurrentCharLoader bucketLoader

bucketQuantity	back to summary
private final int bucketQuantity

bucketSize	back to summary
private final int bucketSize

unwrapping	back to summary
private boolean unwrapping

Constructor Detail

ConcurrentCharInputReader back to summary

ConcurrentCharInputReader	back to summary
public ConcurrentCharInputReader(char normalizedLineSeparator, int bucketSize, int bucketQuantity, int whitespaceRangeStart, boolean closeOnStop) Creates a new instance with the mandatory characters for handling newlines transparently. Line separators will be detected automatically. Parameters normalizedLineSeparator:char the normalized newline character (as defined in `Format#getNormalizedNewline()`) that is used to replace any lineSeparator sequence found in the input. bucketSize:int the size of an each individual "bucket" used to store characters read from the input. bucketQuantity:int the number of "buckets" to load in memory. Note the reader will stop if all buckets are full. whitespaceRangeStart:int starting range of characters considered to be whitespace. closeOnStop:boolean indicates whether to automatically close the input when `stop()` is called

public ConcurrentCharInputReader(char normalizedLineSeparator, int bucketSize, int bucketQuantity, int whitespaceRangeStart, boolean closeOnStop)

Creates a new instance with the mandatory characters for handling newlines transparently. Line separators will be detected automatically.

Parameters

normalizedLineSeparator:char: the normalized newline character (as defined in Format#getNormalizedNewline()) that is used to replace any lineSeparator sequence found in the input.
bucketSize:int: the size of an each individual "bucket" used to store characters read from the input.
bucketQuantity:int: the number of "buckets" to load in memory. Note the reader will stop if all buckets are full.
whitespaceRangeStart:int: starting range of characters considered to be whitespace.
closeOnStop:boolean: indicates whether to automatically close the input when stop() is called

ConcurrentCharInputReader back to summary

ConcurrentCharInputReader	back to summary
public ConcurrentCharInputReader(char[] lineSeparator, char normalizedLineSeparator, int bucketSize, int bucketQuantity, int whitespaceRangeStart, boolean closeOnStop) Creates a new instance with the mandatory characters for handling newlines transparently. Parameters lineSeparator:char[] the sequence of characters that represent a newline, as defined in `Format#getLineSeparator()` normalizedLineSeparator:char the normalized newline character (as defined in `Format#getNormalizedNewline()`) that is used to replace any lineSeparator sequence found in the input. bucketSize:int the size of an each individual "bucket" used to store characters read from the input. bucketQuantity:int the number of "buckets" to load in memory. Note the reader will stop if all buckets are full. whitespaceRangeStart:int starting range of characters considered to be whitespace. closeOnStop:boolean indicates whether to automatically close the input when `stop()` is called

public ConcurrentCharInputReader(char[] lineSeparator, char normalizedLineSeparator, int bucketSize, int bucketQuantity, int whitespaceRangeStart, boolean closeOnStop)

Creates a new instance with the mandatory characters for handling newlines transparently.

Parameters

lineSeparator:char[]: the sequence of characters that represent a newline, as defined in Format#getLineSeparator()
normalizedLineSeparator:char: the normalized newline character (as defined in Format#getNormalizedNewline()) that is used to replace any lineSeparator sequence found in the input.
bucketSize:int: the size of an each individual "bucket" used to store characters read from the input.
bucketQuantity:int: the number of "buckets" to load in memory. Note the reader will stop if all buckets are full.
whitespaceRangeStart:int: starting range of characters considered to be whitespace.
closeOnStop:boolean: indicates whether to automatically close the input when stop() is called

Method Detail

reloadBuffer back to summary

reloadBuffer	back to summary
protected void reloadBuffer() Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.reloadBuffer. Assigns the next "bucket" of characters to the `ConcurrentCharInputReader#buffer` attribute, and updates the `ConcurrentCharInputReader#length` to the number of characters read. Annotations @Override

protected void reloadBuffer()

Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.reloadBuffer.

Assigns the next "bucket" of characters to the ConcurrentCharInputReader#buffer attribute, and updates the ConcurrentCharInputReader#length to the number of characters read.

Annotations

@Override

setReader back to summary

setReader	back to summary
protected void setReader(Reader reader) Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.setReader. Starts an input reading thread to load characters from the given reader into "buckets" of characters Parameters reader:Reader Doc from com.univocity.parsers.common.input.AbstractCharInputReader.setReader. the `java.io.Reader` provided in `AbstractCharInputReader#start(Reader)` Annotations @Override

protected void setReader(Reader reader)

Implements abstract com.univocity.parsers.common.input.AbstractCharInputReader.setReader.

Starts an input reading thread to load characters from the given reader into "buckets" of characters

Parameters

reader:Reader

Doc from com.univocity.parsers.common.input.AbstractCharInputReader.setReader.

the java.io.Reader provided in AbstractCharInputReader#start(Reader)

Annotations

@Override

stop back to summary

stop	back to summary
public void stop() Implements com.univocity.parsers.common.input.CharInputReader.stop. Stops the CharInputReader from reading characters from the `java.io.Reader` provided in `ConcurrentCharInputReader#start(Reader)` and closes it. Also stops the input reading thread. Annotations @Override

public void stop()

Implements com.univocity.parsers.common.input.CharInputReader.stop.

Stops the CharInputReader from reading characters from the java.io.Reader provided in ConcurrentCharInputReader#start(Reader) and closes it. Also stops the input reading thread.

Annotations

@Override

public Class ConcurrentCharInputReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail