univocity-parsers 2.9.1 · com.univocity.parsers.common.iterators.ParserIterator

An Iterator over the parser enabling easy iteration against rows and records Multiple iterations are possible if Files are being fed into the parser, but other forms of input (such as InputStreams and Readers) can not be iterated over more than once.

Field Summary

Modifier and Type	Field and Description
protected final AbstractParser<T extends CommonParserSettings<?>>	parser

Constructor Summary

Access	Constructor and Description
protected	ParserIterator(AbstractParser<T extends CommonParserSettings<?>> the `parser` to iterate over parser) Creates a `ParserIterator` using the provided `parser`

Method Summary

Modifier and Type	Method and Description
protected abstract void	beginParsing() This method is called whenever the `iterator` is starting to iterate over the results.
public final ParsingContext	getContext() Implements com.univocity.parsers.common.IterableResult.getContext. Returns the current parsing `Context`, if available
public final ResultIterator<T, ParsingContext>	iterator() Implements com.univocity.parsers.common.IterableResult.iterator. Returns an iterator over elements of type `T`.
protected abstract T	Returns: the next record if available. nextResult() Returns the next record (either a String[] or a `Record`)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

parser	back to summary
protected final AbstractParser<T extends CommonParserSettings<?>> parser

Constructor Detail

ParserIterator back to summary

ParserIterator	back to summary
protected ParserIterator(AbstractParser<T extends CommonParserSettings<?>> parser) Creates a `ParserIterator` using the provided `parser` Parameters parser:AbstractParser<T extends CommonParserSettings<?>> the `parser` to iterate over

protected ParserIterator(AbstractParser<T extends CommonParserSettings<?>> parser)

Creates a ParserIterator using the provided parser

Parameters

parser:AbstractParser<T extends CommonParserSettings<?>>: the parser to iterate over

Method Detail

beginParsing back to summary

beginParsing	back to summary
protected abstract void beginParsing() This method is called whenever the `iterator` is starting to iterate over the results. an example implementation of this is: `@Override public void beginParsing(){ parser.beginParsing(input); }` This is to allow for different input types such as `Reader, File, or InputStream` without large code reuse.

protected abstract void beginParsing()

This method is called whenever the iterator is starting to iterate over the results. an example implementation of this is:

    @Override
    public void beginParsing(){
        parser.beginParsing(input);
    }

This is to allow for different input types such as Reader, File, or InputStream without large code reuse.

getContext back to summary

getContext	back to summary
public final ParsingContext getContext() Implements com.univocity.parsers.common.IterableResult.getContext. Doc from com.univocity.parsers.common.IterableResult.getContext. Returns the current parsing `Context`, if available Returns:ParsingContext the contextual object with information about an ongoing parsing process Annotations @Override

public final ParsingContext getContext()

Implements com.univocity.parsers.common.IterableResult.getContext.

Doc from com.univocity.parsers.common.IterableResult.getContext.

Returns the current parsing Context, if available

Returns:ParsingContext

the contextual object with information about an ongoing parsing process

Annotations

@Override

iterator back to summary

iterator	back to summary
public final ResultIterator<T, ParsingContext> iterator() Implements com.univocity.parsers.common.IterableResult.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:ResultIterator<T, ParsingContext> an Iterator. Annotations @Override

public final ResultIterator<T, ParsingContext> iterator()

Implements com.univocity.parsers.common.IterableResult.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:ResultIterator<T, ParsingContext>

an Iterator.

Annotations