org.vishia.util

Class StringPartFromFileLines

java.lang.Object

org.vishia.util.StringPart

org.vishia.util.StringPartScan

org.vishia.util.StringPartFromFileLines

All Implemented Interfaces:

java.lang.CharSequence, java.lang.Comparable<java.lang.CharSequence>, java.lang.Iterable<StringPart>

public class StringPartFromFileLines
extends StringPartScan

This class extends the StringPartScan to determine the content with reading the String from a file, from a file resource in jar file or from any other opened resource as Reader.
The resource itself can have a unlimited length. The length of the buffer is determined in the constructor. The next content is read using readNextContent(int). This routine checks whether there is enough space to read a next content. The essential values for that are the StringPart.begin value. It is assumed that the content before StringPart.begin are already processed and hence no more necessary. Additional the readNextContent(int) expects an at least number of chars to read. If the StringPart.begin is lesser as that argument, nothing is read. With that rule the readNextContent(int) can be called any time without check, but does nothing of it is not necessary, to save time.

Calculation of the buffer size and the minPosToRead:
It should be regarded that a currently scan process uses a spread in the text. Sometimes the parsing runs in iterations and is reseted to a more left start point. It depends from the algorithm of evaluating the content. The ideal case is, that the whole file can take place in the buffer. But then with decision of the buffer size the file size to evaluate is also determined.

The necessary spread for parsing determines the size. If a file can be parsed line per line then the buffer size (constructor argument) should be greater than twice times the longest expected line or for non-lined orientated files the longest expected element. For example on XML files the longest exepected element is the longest value for a text of an element of an attribute value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	StringPartFromFileLines.CharSq

Nested classes/interfaces inherited from class org.vishia.util.StringPart

StringPart.Iter, StringPart.Part

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bEof
(package private) boolean	bLesserReadAsExpected
(package private) char[]	cBuffer
private char	cExpectedSesoncNl The second newline character set if the first nl was read.
(package private) java.nio.charset.Charset	charset
(package private) int	endIxLinePosition After the last used position in the linePositions array.
(package private) java.io.Reader	inpr The reader maybe with correct charset.
(package private) IntegerBlockArray	linePositions
(package private) int	nLineCt Current line.
(package private) int	nrFirstLineInPositions The number of the first line for the current position
(package private) java.lang.String	sNewline
static java.lang.String	version Version, history and license.
(package private) int	zBuffer Nr of characters in buffer.

Fields inherited from class org.vishia.util.StringPartScan

beginScan, beginScanLast, nLastFloatNumber, nLastIntegerNumber, nLastIntegerSign, sLastString, sVersion

Fields inherited from class org.vishia.util.StringPart

absPos0, bCurrentOk, begiMin, begin, beginLast, bFound, bitMode, bStartScan, content, end, endLast, endMax, mSeekBack, mSeekCheck, mSeekEnd, mSeekToLeft, mSkipOverCommentInsideText_mode, mSkipOverCommentToEol_mode, mSkipOverWhitespace_mode, sCheckNewline, sCheckWhitespaces, sCommentEnd, sCommentStart, sCommentToEol, seekBack, seekEnd, seekNormal, seekToLeft, sFile

Constructor Summary

Constructors

Constructor and Description
StringPartFromFileLines(java.lang.Class<?> clazz, java.lang.String pathInJarFromClazz, int maxSizeBuffer, java.lang.String sEncodingDetect, java.nio.charset.Charset charsetDefault) Loads a resource from jar file into this StringBuffer.
StringPartFromFileLines(java.io.File fromFile) Fills a StringPart from a File.
StringPartFromFileLines(java.io.File fromFile, int maxBuffer, java.lang.String sEncodingDetect, java.nio.charset.Charset charset) Fills a StringPart from a File.
StringPartFromFileLines(java.io.InputStream input, java.lang.String sInputPath, int sizeBuffer, java.lang.String sEncodingDetect, java.nio.charset.Charset charsetDefault) Fills a StringPart from a opened Stream.
StringPartFromFileLines(java.io.Reader input, java.lang.String sInputPath, int sizeBuffer) Fills a StringPart from a opened Stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the work.
private int	evalLineIndices(int from, int to)
int	getLineAndColumn(int[] column) Returns the line and column of the current position.
boolean	readNextContent(int minPosToRead) Read next content from the file.
boolean	readnextContentFromFile(int minSizeForAction) Deprecated. use readNextContent(int) as the overridden form of base routine.

Methods inherited from class org.vishia.util.StringPartScan

getCircumScriptionToAnyChar, getCircumScriptionToAnyCharOutsideQuotion, getLastScannedFloatNumber, getLastScannedIntegerNumber, getLastScannedIntegerSign, getLastScannedPart, getLastScannedPart, getLastScannedString, scan, scan, scanAnyChar, scanChar, scanDigits, scanDigits, scanFloatNumber, scanFloatNumber, scanFloatNumber, scanFractionalExponent, scanFractionalNumber, scanHex, scanHex, scanHexOrDecimal, scanHexOrDecimal, scanIdentifier, scanIdentifier, scanInteger, scanInteger, scanInteger, scanLiteral, scanOk, scanPositivInteger, scanQuotion, scanQuotion, scanSkipComment, scanSkipSpace, scanStart, scanStart, scanToAnyChar, scanToAnyChar, seekScanPos

Methods inherited from class org.vishia.util.StringPart

absCharAt, absSubString, assign, assign, assignFromEnd, assignReplaceEnv, charAt, checkCharAt, clean, compareTo, contentTillSpaceEndOrQuotation, debugString, equals, firstlineMaxpart, found, fromEnd, getCharSequenceRange, getCurrent, getCurrent, getCurrentChar, getCurrentColumn, getCurrentPart, getCurrentPart, getCurrentPosition, getInputfile, getLastPart, getLenCurrent, getPart, indexEndOfQuotation, indexEndOfQuotation, indexEndOfQuotion, indexOf, indexOf, indexOf, indexOf, indexOfAnyChar, indexOfAnyChar, indexOfAnyChar, indexOfAnyCharOutsideQuotation, indexOfAnyCharOutsideQuotion, indexOfAnyString, indexOfNoChar, indexOfNoChar, iterator, lastIndexOfAnyChar, len0end, lenBacktoNoChar, lenBacktoNoWhiteSpaces, length, lengthMaxPart, lento, lento, lento, lento, lentoAnyChar, lentoAnyChar, lentoAnyChar, lentoAnyCharOutsideQuotation, lentoAnyCharOutsideQuotion, lentoAnyNonEscapedChar, lentoAnyString, lentoAnyString, lentoAnyStringWithIndent, lentoIdentifier, lentoIdentifier, lentoLineEnd, lentoNonEscapedString, lentoNumber, lentoPos, lentoQuotionEnd, line, nextlineMaxpart, replace, seek, seek, seek, seek, seekAfterNewline, seekAnyChar, seekAnyString, seekBackToAnyChar, seekBackward, seekBegin, seekCheck, seekCheckEnd, seekEnd, seekNextLine, seekNoChar, seekNoWhitespace, seekNoWhitespaceOrComments, seekPos, seekPosBack, setBeginMaxPart, setCurrentMaxPart, setCurrentPartTo, setCurrentPosition, setIgnoreComment, setIgnoreComment, setIgnoreEndlineComment, setIgnoreEndlineComment, setIgnoreWhitespaces, setInputfile, setLengthMax, setParttoMax, skipWhitespaceAndComment, startsWith, subSequence, substring, toString, trim, trimComment, trimWhiteSpaces, XXXindexOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

version

public static final java.lang.String version

Version, history and license. list of changes:

2022-03-28 Hartmut bugfix: Now returns the first line as 1. Before, the first line was 0. Yet this is used for test, not only manual view, thats why finally fixed.
• 2020-02-10 Hartmut new StringPartFromFileLines(Reader, String, int)
StringPartFromFileLines(InputStream, String, int, String, Charset) with negativ argument sizeBuffer
• 2020-02-02 Hartmut new StringPartFromFileLines(Class, String, int, String, Charset)
StringPartFromFileLines(InputStream, String, int, String, Charset) with negativ argument sizeBuffer
• 2018-12-22 Hartmut bugfix in StringPart, improvement here: readnextContentFromFile(int) shifts only StringPart.begin/2 to save the content near to and left from the current working area for access capability of a Part near the current content.
• 2018-01-06 Hartmut bugfix, bug: If the file to read was only 201..209 Bytes, the bytes after 200 were not read. fix: readnextContentFromFile(0) instead (10) necessary, to read in any case. 2017-12: Renaming package private maxIxLinePosition vs. endIxLinePosition.
• 2016-09-25 Hartmut now works with lesser buffer.
• 2015-10-24 Hartmut new: StringPartFromFileLines(InputStream, String, int, String, Charset) to use with ClassLoader.getSystemClassLoader().getResourceAsStream("path");
• 2015-06-07 Hartmut chg: getLineAndColumn(int[]): column counts from 1 on leftest position.
• 2014-05-22 Hartmut new: StringPart.setInputfile(String) invoked with input file
• 2014-04-22 Hartmut chg: improved line numbers
• 2012-12-22 Hartmut chg: close() the file in constructor if the whole file was read.
• 2010-02-11 Hartmut new: The ctor StringPartFromFileLines(File fromFile) is added, it is compatible to StringPartFromFile now.
• 2009-05-31 Hartmut detecting and ignoring a BOM (byte order mark) as first char.
• 2009-04-09 Hartmut encoding detection korrig.
• 2006-05-00 Hartmut creation

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

cBuffer

final char[] cBuffer

zBuffer

int zBuffer

Nr of characters in buffer.

charset

final java.nio.charset.Charset charset

cExpectedSesoncNl

private char cExpectedSesoncNl

The second newline character set if the first nl was read. It is a member variable because its possible that the buffer was filled exactly between 1. and 2. newline character.

nLineCt

int nLineCt

Current line.

bEof

boolean bEof

bLesserReadAsExpected

boolean bLesserReadAsExpected

inpr

java.io.Reader inpr

The reader maybe with correct charset.

nrFirstLineInPositions

int nrFirstLineInPositions

The number of the first line for the current position

linePositions

IntegerBlockArray linePositions

endIxLinePosition

int endIxLinePosition

After the last used position in the linePositions array.

sNewline

java.lang.String sNewline

Constructor Detail

StringPartFromFileLines

public StringPartFromFileLines(java.io.File fromFile)
                        throws java.io.FileNotFoundException,
                               java.io.IOException,
                               java.nio.charset.IllegalCharsetNameException,
                               java.nio.charset.UnsupportedCharsetException

Fills a StringPart from a File. If the file is less than the maxBuffer size, the whole file is inputed into the StringPart, otherwise the StringPart is reloaded if the first area is proceed. This constructor ivokes StringPartFromFileLines(File, int, String, Charset) with default arguments for charset and buffer size.

Parameters:

fromFile - The file to read

Throws:

java.io.FileNotFoundException - If the file is not found

java.io.IOException - If any other exception is thrown

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

StringPartFromFileLines

public StringPartFromFileLines(java.io.File fromFile,
                               int maxBuffer,
                               java.lang.String sEncodingDetect,
                               java.nio.charset.Charset charset)
                        throws java.io.FileNotFoundException,
                               java.io.IOException,
                               java.nio.charset.IllegalCharsetNameException,
                               java.nio.charset.UnsupportedCharsetException

Fills a StringPart from a File. If the file is less than the maxBuffer size, the whole file is inputed into the StringPart, otherwise the StringPart is reloaded if the first area is proceed. This constructor invokes StringPartFromFileLines(InputStream, String, int, String, Charset) with the opened file.

Parameters:

fromFile - The file to read

maxBuffer - The maximum of length of the associated StringBuffer.

sEncodingDetect - If not null, this string is searched in the first line, read in US-ASCII or UTF-16-Format. If this string is found, the followed string in quotation marks or as identifier with addition '-' char is read and used as charset name. If the charset name is failed, a CharsetException is thrown. It means, a failed content of file may cause a charset exception.

charset - If not null, this charset is used as default, if no other charset is found in the files first line, see param sEncodingDetect. If null and not charset is found in file, the systems default charset is used.

Throws:

java.io.FileNotFoundException - If the file is not found

java.io.IOException - If any other exception is thrown

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

StringPartFromFileLines

public StringPartFromFileLines(java.lang.Class<?> clazz,
                               java.lang.String pathInJarFromClazz,
                               int maxSizeBuffer,
                               java.lang.String sEncodingDetect,
                               java.nio.charset.Charset charsetDefault)
                        throws java.nio.charset.IllegalCharsetNameException,
                               java.nio.charset.UnsupportedCharsetException,
                               java.io.IOException

Loads a resource from jar file into this StringBuffer. Note: This have to be close() to close the resource.

Parameters:

clazz - This class is the start point of the:

pathInJarFromClazz - relative from clazz, use "../../package/path/to/resource.ext" if it is not in the same package.

maxSizeBuffer - The size for the StringPart is gotten from the resource: InputStream.available(), at least 1000 chars if available() returns not the length, but at least this size.

sEncodingDetect - If not null, this string is searched in the first 2 lines, read in US-ASCII or UTF-16-Format. If this string is found, the followed string in quotion marks or as identifier with addition '-' char is read and used as charset name. If the charset name is failed, a CharsetException is thrown. It means, a failed content of file may cause a charset exception.

charset - If not null, this charset is used as default, if no other charset is found in the files first line, see param sEncodingDetect. If null and not charset is found in file, the systems default charset is used.

Throws:

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

java.io.IOException

StringPartFromFileLines

public StringPartFromFileLines(java.io.Reader input,
                               java.lang.String sInputPath,
                               int sizeBuffer)
                        throws java.io.IOException,
                               java.nio.charset.IllegalCharsetNameException,
                               java.nio.charset.UnsupportedCharsetException

Fills a StringPart from a opened Stream. It can be used for example with ClassLoader.getSystemClassLoader().getResourceAsStream("path"); . It is the core method called in the other constructors using a File input. This is the core routine called from all other constructors. All capabilities described on the other constructors are here.

Parameters:

input - Any input stream, maybe a ClassLoader getRessourceAsStream

sInputPath - Hint for error messages from which input is it.

sizeBuffer - The length of the associated StringBuffer.

Throws:

java.io.IOException

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

StringPartFromFileLines

public StringPartFromFileLines(java.io.InputStream input,
                               java.lang.String sInputPath,
                               int sizeBuffer,
                               java.lang.String sEncodingDetect,
                               java.nio.charset.Charset charsetDefault)
                        throws java.io.IOException,
                               java.nio.charset.IllegalCharsetNameException,
                               java.nio.charset.UnsupportedCharsetException

Fills a StringPart from a opened Stream. It can be used for example with ClassLoader.getSystemClassLoader().getResourceAsStream("path"); . It is the core method called in the other constructors using a File input. This is the core routine called from all other constructors. All capabilities described on the other constructors are here.

Parameters:

input - Any input stream, maybe a ClassLoader getRessourceAsStream

sInputPath - Hint for error messages from which input is it.

sizeBuffer - The length of the associated StringBuffer. If negative, then determine form input.available, but use the given negate number as maximum if >= (-1000).
The size should be 2 * greater as the most length expected line.

sEncodingDetect - If not null, this string is searched in the first 2 lines, read in US-ASCII or UTF-16-Format. If this string is found, the followed string in quotion marks or as identifier with addition '-' char is read and used as charset name. If the charset name is failed, a CharsetException is thrown. It means, a failed content of file may cause a charset exception.

charset - If not null, this charset is used as default, if no other charset is found in the files first line, see param sEncodingDetect. If null and not charset is found in file, the systems default charset is used.

Throws:

java.io.IOException

java.nio.charset.IllegalCharsetNameException

java.nio.charset.UnsupportedCharsetException

Method Detail

getLineAndColumn

public int getLineAndColumn(int[] column)

Returns the line and column of the current position. The line comes from an array which stores all start positions of the line, filled if the line is used. The conversion between the position (used internally) and the line (only for user interface) is done by binarySearch in this array. The array will be increased by demand. It is a IntegerBlockArray which uses blocks of a constant size.

Overrides:

getLineAndColumn in class StringPart

Parameters:

column - The leftest position in a line is 1, like usual in editors.

Returns:

line, 1 is the first line.

See Also:

StringPart.getLineAndColumn(int[])

evalLineIndices

private int evalLineIndices(int from,
                            int to)

readNextContent

public boolean readNextContent(int minPosToRead)
                        throws java.io.IOException

Read next content from the file. It does nothing if the current working area in the text StringPart.begin is lesser the argument minSizeForAction. If does not shift the content if the StringPart.begin is < 1/8 of the size. That is especially after reading head information. But it reads from file if especially minSizeForAction is ==0. If shifts the text in the internal buffer StringPart.content respectively cBuffer (the same) but only the half of current content. Especially Part remain accessible if they are near the current content. See remarks there about persistence.

Overrides:

readNextContent in class StringPartScan

Parameters:

minPosToRead - returns without action if Current position (it is StringPart.begin) is lesser. Set =0 for reading the first content. Set to about 2/3 of size for normal operation.

Returns:

true if eof is possible because lesser bytes than expected are read.

Throws:

java.io.IOException

readnextContentFromFile

@Deprecated
public boolean readnextContentFromFile(int minSizeForAction)
                                             throws java.io.IOException

Deprecated. use readNextContent(int) as the overridden form of base routine.

Read next content from the file. It does nothing if the current working area in the text StringPart.begin is lesser the argument minSizeForAction. If does not shift the content if the StringPart.begin is < 1/8 of the size. That is especially after reading head information. But it reads from file if especially minSizeForAction is ==0. If shifts the text in the internal buffer StringPart.content respectively cBuffer (the same) but only the half of current content. Especially Part remain accessible if they are near the current content. See remarks there about persistence.

Parameters:

minSizeForAction - returns without action if Current position (it is StringPart.begin) is lesser. Set =0 for reading the first content. Set to about 2/3 of size for normal operation.

Returns:

true if eof is possible because lesser bytes than expected are read.

Throws:

java.io.IOException

close

public void close()

Description copied from class: StringPartScan

Closes the work. This routine should be called if the StringPart is never used, but it may be kept because it is part of class data or part of a statement block which runs. The associated String is released. It can be recycled by garbage collector. If this method is overridden, it should used to close a associated file which is opened for this String processing. The overridden method should call super->close() too.

Note: if only this class is instantiated and the instance will be garbaged, close is not necessary. A warning or error "Resource leak" can be switched off. Therefore the interface Closeable is not used here.

Overrides:

close in class StringPartScan