org.openimaj.util.iterator

Class TextLineIterable

java.lang.Object

org.openimaj.util.iterator.TextLineIterable

All Implemented Interfaces:

Iterable<String>

public class TextLineIterable
extends Object
implements Iterable<String>

An Iterable that can provide access to lines of a text file referenced by a File or URL. It is safe to re-use this Iterable instance; a new BufferedReader will be created when iterator() is called. Any IOExceptions are wrapped as RuntimeExceptions.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextLineIterable.GZIPFileProvider A TextLineIterable.Provider for gzipped text files
static interface	TextLineIterable.Provider Interface describing things that can provide input for a TextLineIterable

Constructor Summary

Constructors

Constructor and Description
TextLineIterable(File f) Construct with the given file
TextLineIterable(File f, String charset) Construct with the given file and charset
TextLineIterable(TextLineIterable.Provider source) Construct with the given provider
TextLineIterable(URL f) Construct with the given url
TextLineIterable(URL f, String charset) Construct with the given url and charset

Method Summary

Modifier and Type	Method and Description
Iterator<String>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TextLineIterable

public TextLineIterable(TextLineIterable.Provider source)

Construct with the given provider

Parameters:

source - the provider

TextLineIterable

public TextLineIterable(File f)

Construct with the given file

Parameters:

f - the file

TextLineIterable

public TextLineIterable(File f,
                        String charset)

Construct with the given file and charset

Parameters:

f - the file

charset - the character set

TextLineIterable

public TextLineIterable(URL f,
                        String charset)

Construct with the given url and charset

Parameters:

f - the url

charset - the character set

TextLineIterable

public TextLineIterable(URL f)

Construct with the given url

Parameters:

f - the url

Method Detail

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>