javatools.filehandlers

Class FileLines

java.lang.Object

javatools.datatypes.PeekIterator<String>

javatools.filehandlers.FileLines

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>, Iterator<String>

Direct Known Subclasses:

ByteFileLines

public class FileLines
extends PeekIterator<String>
implements Iterable<String>, Iterator<String>, Closeable

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The class provides an iterator over the lines in a file
Example:

 for (String s : new FileLines("c:\\autoexec.bat")) {
        System.out.println(s);
 }
 

If desired, the iterator can make a nice progress bar by calling Announce.progressStart/At/Done automatically in the right order. If there are no more lines, the file is closed. If you do not use all lines of the iterator, close the iterator manually.

Nested Class Summary

Nested classes/interfaces inherited from class javatools.datatypes.PeekIterator

PeekIterator.ElementaryPeekIterator<T>, PeekIterator.SimplePeekIterator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	announceChars number of chars for announce (or -1)
protected BufferedReader	br Containes the Reader
static long	maxChars Maximum chars to read by readTo (or -1)

Fields inherited from class javatools.datatypes.PeekIterator

closed, EMPTY, fetchedNextValue, next

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileLines() For subclasses
	FileLines(BufferedReader r) Constructs FileLines from a BufferedReader (main constructor 3)
	FileLines(File f) Constructs FileLines from a file
	FileLines(File f, String announceMsg) Constructs FileLines from a file, shows progress bar (main constructor 2)
	FileLines(File f, String encoding, String announceMsg) Constructs FileLines from a file with an encoding, shows progress bar (main constructor 1)
	FileLines(Reader f) Constructs FileLines from a Reader
	FileLines(String f) Constructs FileLines from a filename
	FileLines(String f, String announceMsg) Constructs FileLines from a filename, shows progress bar
	FileLines(String f, String encoding, String announceMsg) Constructs FileLines from a filename with a given encoding, shows progress bar

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader
void	finalize() Closes the reader
static int	find(Reader in, String... findMe) Reads until one of the strings is found, returns its index or -1.
static int	find(Reader in, StringBuilder b, String... findMe) Reads until one of the strings is found, returns its index or -1.
static int	findIgnoreCase(Reader in, String... findMe) Reads until one of the strings is found, returns its index or -1.
static int	firstCharAfterSpace(Reader in) Skips space
String	internalNext() Returns next line.
Iterator<String>	iterator() Returns this
static int	numAllFileLines(File f, String ext) returns number of lines in file
static int	numFileLines(File f) returns number of lines in file
static String	readBetween(Reader in, String start, String end) Reads the string between the delimiters
static String	readBetween(String in, String start, String end) Reads the string between the delimiters
static CharSequence	readTo(Reader in, char... limit) Reads to a specific character, returns the text in between
static CharSequence	readTo(Reader in, char limit) Reads to a specific character, returns the text in between
static String	readTo(Reader in, CharSequence... findMe) Reads until one of the strings is found, returns the string
static CharSequence	readTo(Reader in, String limit) Reads to a specific String, returns the text up to there, including the limit
static CharSequence	readTo(Reader in, String limit, List<Integer> results) Reads to a specific String, returns the text up to there, including the limit
static String	readToBoundary(Reader in, String limit) Reads to a specific string, returns text up to there, without boundary or returns NULL
static CharSequence	readToSpace(Reader in) Reads to a whitespace
void	remove() Unsupported, throws an UnsupportedOperationException
static boolean	scrollTo(Reader in, char... delimiters) Scrolls to one of the characters
static boolean	scrollTo(Reader in, char delimiter) Reads to a specific character
static boolean	scrollTo(Reader in, String limit) Scrolls to a specific limit and beyond
String	toString() Returns a simple identifier

Methods inherited from class javatools.datatypes.PeekIterator

asList, asList, asSet, asSet, asSet, emptyIterator, hasNext, internalSilentNext, list, list, main, next, nextOrNull, numElements, numElements, peek, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Field Detail

announceChars

protected long announceChars

number of chars for announce (or -1)

br

protected BufferedReader br

Containes the Reader

maxChars

public static long maxChars

Maximum chars to read by readTo (or -1)

Constructor Detail

FileLines

public FileLines(String f)
          throws IOException

Constructs FileLines from a filename

Throws:

IOException

FileLines

public FileLines(File f)
          throws IOException

Constructs FileLines from a file

Throws:

IOException

FileLines

public FileLines(String f,
                 String announceMsg)
          throws IOException

Constructs FileLines from a filename, shows progress bar

Throws:

IOException

FileLines

public FileLines(String f,
                 String encoding,
                 String announceMsg)
          throws IOException

Constructs FileLines from a filename with a given encoding, shows progress bar

Throws:

IOException

FileLines

public FileLines(File f,
                 String encoding,
                 String announceMsg)
          throws IOException

Constructs FileLines from a file with an encoding, shows progress bar (main constructor 1)

Throws:

IOException

FileLines

public FileLines(File f,
                 String announceMsg)
          throws IOException

Constructs FileLines from a file, shows progress bar (main constructor 2)

Throws:

IOException

FileLines

public FileLines(Reader f)

Constructs FileLines from a Reader

FileLines

public FileLines(BufferedReader r)

Constructs FileLines from a BufferedReader (main constructor 3)

FileLines

protected FileLines()

For subclasses

Method Detail

remove

public void remove()
            throws UnsupportedOperationException

Unsupported, throws an UnsupportedOperationException

Specified by:

remove in interface Iterator<String>

Overrides:

remove in class PeekIterator<String>

Throws:

UnsupportedOperationException

internalNext

public String internalNext()

Returns next line. In case of an IOException, the exception is wrapped in a RuntimeException

Specified by:

internalNext in class PeekIterator<String>

toString

public String toString()

Returns a simple identifier

Overrides:

toString in class PeekIterator<String>

iterator

public Iterator<String> iterator()

Returns this

Specified by:

iterator in interface Iterable<String>

Overrides:

iterator in class PeekIterator<String>

close

public void close()

Closes the reader

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class PeekIterator<String>

finalize

public void finalize()

Closes the reader

Overrides:

finalize in class Object

readTo

public static String readTo(Reader in,
                            CharSequence... findMe)
                     throws IOException

Reads until one of the strings is found, returns the string

Throws:

IOException

find

public static int find(Reader in,
                       String... findMe)
                throws IOException

Reads until one of the strings is found, returns its index or -1.

Throws:

IOException

find

public static int find(Reader in,
                       StringBuilder b,
                       String... findMe)
                throws IOException

Reads until one of the strings is found, returns its index or -1.

Throws:

IOException

findIgnoreCase

public static int findIgnoreCase(Reader in,
                                 String... findMe)
                          throws IOException

Reads until one of the strings is found, returns its index or -1.

Throws:

IOException

readTo

public static CharSequence readTo(Reader in,
                                  char... limit)
                           throws IOException

Reads to a specific character, returns the text in between

Throws:

IOException

readToSpace

public static CharSequence readToSpace(Reader in)
                                throws IOException

Reads to a whitespace

Throws:

IOException

firstCharAfterSpace

public static int firstCharAfterSpace(Reader in)
                               throws IOException

Skips space

Throws:

IOException

readTo

public static CharSequence readTo(Reader in,
                                  char limit)
                           throws IOException

Reads to a specific character, returns the text in between

Throws:

IOException

readTo

public static CharSequence readTo(Reader in,
                                  String limit)
                           throws IOException

Reads to a specific String, returns the text up to there, including the limit

Throws:

IOException

readToBoundary

public static String readToBoundary(Reader in,
                                    String limit)
                             throws IOException

Reads to a specific string, returns text up to there, without boundary or returns NULL

Throws:

IOException

scrollTo

public static boolean scrollTo(Reader in,
                               char... delimiters)
                        throws IOException

Scrolls to one of the characters

Throws:

IOException

scrollTo

public static boolean scrollTo(Reader in,
                               char delimiter)
                        throws IOException

Reads to a specific character

Throws:

IOException

scrollTo

public static boolean scrollTo(Reader in,
                               String limit)
                        throws IOException

Scrolls to a specific limit and beyond

Throws:

IOException

readBetween

public static String readBetween(Reader in,
                                 String start,
                                 String end)
                          throws IOException

Reads the string between the delimiters

Throws:

IOException

readBetween

public static String readBetween(String in,
                                 String start,
                                 String end)

Reads the string between the delimiters

readTo

public static CharSequence readTo(Reader in,
                                  String limit,
                                  List<Integer> results)
                           throws IOException

Reads to a specific String, returns the text up to there, including the limit

Throws:

IOException

numFileLines

public static int numFileLines(File f)
                        throws IOException

returns number of lines in file

Throws:

IOException

numAllFileLines

public static int numAllFileLines(File f,
                                  String ext)
                           throws IOException

returns number of lines in file

Throws:

IOException