org.vishia.util

Class StringFunctions

java.lang.Object

org.vishia.util.StringFunctions

public class StringFunctions
extends java.lang.Object

This class contains static String functions without any other dependency able to use with CharSequence (instead java.lang.String).
All routines with a range selection have the following rule:

• The start position (from) counts from 0 till end as absolute position.
• The end position (to) counts positive from 0 till end as absolute position
• The end position (to) counts negative from -1 till start as relative position from end.
• The end position -1 means, the whole String.
• If the end position is greater end (positive), it is till end. It means, Integer.MAX_VALUE can be used instead -1 too.
• If the end position is less than the start, the range is 0. An exception is not thrown. Due to end position an exception is never thrown.
• If the start position is outside the range of source, an Exception is thrown. In C the functions are contained in the emC/String_emC.c.

Field Summary

Fields

Modifier and Type	Field and Description
static char	cEndOfText The char used to code end of text.
static char	cNoCidentifier The char used to coding any char which is not an identifier character usual in programming languages like C, Java: A..Z a..z 0..9 _.
static char	cStartOfText The char used to code start of text.
(package private) static java.lang.String	indentString
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
StringFunctions()

Method Summary

Modifier and Type	Method and Description
static short	byte2UTF8(byte[] src, int[] ixSrc) Converts the current bytes in a byte[] from UTF-8 in a UTF16-character.
static int	compare(java.lang.CharSequence s1, java.lang.CharSequence s2) Compares two Strings or StringBuilder-content or any other CharSequence.
static int	compare(java.lang.CharSequence s1, int from1, java.lang.CharSequence s2, int from2, int nrofChars) Compares two CharSequence (Strings, StringBuilder-content etc.
static int	compareChars(java.lang.CharSequence s1, int from, int to, java.lang.CharSequence s2) Compare two character Strings.
static int	comparePos(java.lang.CharSequence s1, java.lang.CharSequence s2) Compares two CharSequence (Strings, StringBuilder-content etc.
static int	comparePos(java.lang.CharSequence s1, int from1, java.lang.CharSequence s2, int from2, int nrofChars) Compares two CharSequence (Strings, StringBuilder-content etc.)
static int	compareWhSpacePos(java.lang.CharSequence s1, int from1, int to1, java.lang.CharSequence s2, int from2, int to2, int[] p2Out) Compare two Strings whereby white spaces are ignored.
static boolean	contains(java.lang.CharSequence s1, java.lang.CharSequence s2) Returns true if s2 is contained in s1.
static java.lang.CharSequence	convertTransliteration(java.lang.CharSequence src, char transcriptChar) Resolves the given String containing some transcription chars (usual backslash) to a string with the appropriate character codes.
static int	copyToBuffer(java.lang.String src, byte[] buffer, java.nio.charset.Charset encoding) Copies the content of a String in the given byte buffer with the requested encoding.
static int	copyToBuffer(java.lang.String src, char[] buffer) Copies the content of a String in the given char buffer.
static boolean	endsWith(java.lang.CharSequence sq, java.lang.CharSequence end) Checks whether the given CharSequence ends with a CharSequence.
static boolean	equals(java.lang.CharSequence s1, java.lang.CharSequence s2) Compares two Strings or StringBuilder-content or any other CharSequence.
static boolean	equals(java.lang.CharSequence s1, int from, int to, java.lang.CharSequence s2) Compares two charsequences.
static java.lang.String	indent2(int indent) Returns a String with 2*indent spaces for indentation.
static int	indexAfterAnyChar(java.lang.CharSequence sq, int begin, int endMax, java.lang.CharSequence sChars) Searches the first character which is not contains in any given characters.
static int	indexAfterIdentifier(java.lang.CharSequence src, int start, int endMax, java.lang.String additionalChars) Returns the position after the end of an identifier.
static int	indexAfterIdentifierOld(java.lang.CharSequence src, int start, int endMax, java.lang.String additionalChars) Deprecated.
static int	indexIdentifier(java.lang.CharSequence src, int start, int endMax, java.lang.String additionalStartChars) Searches the position of the first identifier character starting from the given position.
static int	indexNoWhitespace(java.lang.CharSequence src, int start, int endMax) Searches the first non-whitespace in src from start till at maximal endMax.
static int	indexOf(java.lang.CharSequence sq, char ch) Searches the first occurrence of the given Character in a CharSequence.
static int	indexOf(java.lang.CharSequence sq, char ch, int fromIndex) Searches the first occurrence of the given Character in a CharSequence.
static int	indexOf(java.lang.CharSequence sq, java.lang.CharSequence str) Searches the first occurrence of the given CharSequence in a CharSequence.
static int	indexOf(java.lang.CharSequence sq, java.lang.CharSequence str, int fromIndex) Searches the first occurrence of the given CharSequence in a CharSequence.
static int	indexOf(java.lang.CharSequence sq, int fromIndex, int to, char ch) Searches the first occurrence of the given character in a CharSequence.
static int	indexOf(java.lang.CharSequence sq, int fromIndex, int to, java.lang.CharSequence str) Checks whether the given CharSequence contains the other given CharSequence.
static int	indexOf(java.lang.CharSequence sq, int fromIndex, int to, java.lang.String str) Checks whether the given CharSequence contains the other given CharSequence.
static int	indexOfAnyChar(java.lang.CharSequence sq, int begin, int endMax, java.lang.CharSequence sChars) Searches any char inside sChars in the given Charsequence
static int	indexOfAnyChar(java.lang.CharSequence sq, int begin, int endMax, java.lang.CharSequence sChars, int[] nr) Searches any char inside sChars in the given CharSequence.
static int	indexOfAnyCharOutsideQuotation(java.lang.CharSequence sq, int begin, int endMax, java.lang.CharSequence sChars, java.lang.CharSequence sQuotChars, java.lang.CharSequence sQuotEndChars, char transcriptChar, int[] nr) Searches the first occurrence of some given characters in a CharSequence whereby characters in quotation are not checked.
static int	indexOfAnyString(java.lang.CharSequence sq, int from, int to, java.lang.CharSequence[] listStrings, int[] nrofFoundString, java.lang.String[] foundString) Returns the position of one of the strings in listStrings within the given sq, maybe started inside the sq with from, returns -1 if the char is not found in the part started from 'fromIndex'.
static int	indexOutsideQuotation(java.lang.CharSequence sq, int begin, int endMax, char csearch, java.lang.CharSequence sQuotChars, java.lang.CharSequence sQuotEndChars, char transcriptChar) Searches the first occurrence of the given character in a CharSequence whereby characters in quotation are not checked.
static int	indexWhitespace(java.lang.CharSequence src, int start, int endMax) Searches the first whitespace in src from start till at maximal endMax.
static boolean	isEmptyOrOnlyWhitespaces(java.lang.CharSequence text) Returns false if at least one char was found in text which is not a whitespace.
static int	lastIndexOf(java.lang.CharSequence sq, char ch) Searches the last occurrence of the given char in a CharSequence.
static int	lastIndexOf(java.lang.CharSequence sq, int from, int end, char ch) Searches the last occurrence of the given char in a CharSequence.
static int	lastIndexOf(java.lang.CharSequence sq, int fromIndex, int to, java.lang.CharSequence str) Checks whether the given CharSequence contains the other given CharSequence.
static int	lastIndexOf(java.lang.CharSequence sq, int fromIndex, int to, java.lang.String str) Checks whether the given CharSequence contains the given String.
static int	lastIndexOfAnyChar(java.lang.CharSequence sq, int from, int to, java.lang.CharSequence chars) Searches the last occurrence of one of the given chars in a CharSequence.
static int	lastIndexOfNoChar(java.lang.CharSequence sq, int from, int to, java.lang.CharSequence chars) Searches the last occurrence in a CharSequence of any char which is not given in chars.
static java.lang.String	nl_indent2(int indent) Returns a String with a newline \n character and 2*indent spaces for indentation.
static int	nrofBytesUTF8(byte b) Returns the number of bytes to the UTF start byte.
static int	posAfterIdentifier(java.lang.CharSequence src, int start, int endMax) Deprecated. use indexAfterIdentifier(CharSequence, int, int, String)
static int	posAfterIdentifier(java.lang.CharSequence src, int start, int endMax, java.lang.String additionalStartChars, java.lang.String additionalChars) Deprecated. use indexAfterIdentifier(CharSequence, int, int, String)
private static int	skipOverQuotation(java.lang.CharSequence sq, int pos, int endMax, char cc, java.lang.CharSequence sQuotChars, java.lang.CharSequence sQuotEndChars, int zQu, char transcriptChar) Only internal used.
static boolean	startsWith(java.lang.CharSequence sq, java.lang.CharSequence start) Checks whether the given CharSequence starts with a defined CharSequence.
static boolean	startsWith(java.lang.CharSequence sq, int from, int endMax, java.lang.CharSequence start) Checks whether the given CharSequence starts with a CharSequence.
static int	startsWithAfterAnyChar(java.lang.CharSequence sq, java.lang.CharSequence start, java.lang.String anyCharBeforeStart) Checks whether a given sq starts with the compare sequence start, but after some admissible characters.
(package private) boolean	test(java.lang.String s)
(package private) int	utf16toUTF8bytes(char cc, byte[] buffer, int posBuffer) Converts a UTF16 character to 1..3 bytes UTF8
static short	utf8to16(byte[] src, int[] ixSrc) Converts the current bytes in a byte[] from UTF-8 in a UTF16-character.
static java.lang.String	z_StringJc(char[] buffer) Converts a String in a buffer in a java.lang.String.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-06-08 Hartmut bugfix/chg: Now indexAfterIdentifier(CharSequence, int, int, String) returns 0 if the position starts with a number. That is proper also for test whether currently it is an identifier and it is consequent. The old behavior of this operation is now available in indexAfterIdentifierOld(CharSequence, int, int, String).
• 2023-04-30 Hartmut bugfix startsWith(CharSequence, CharSequence): was faulty if number of chars to compare is equal the length.
• 2023-04-02 Hartmut bugfix comparePos(CharSequence, int, CharSequence, int, int): If any String is longer than nrofChars but the rest is equal, now returns 0. (Before, returns a value > nrofChars).
• 2022-05-09 Hartmut new startsWithAfterAnyChar(CharSequence, CharSequence, String), new indexAfterAnyChar(CharSequence, int, int, CharSequence)
• 2022-05-09 Hartmut new compareWhSpacePos(CharSequence, int, int, CharSequence, int, int, int[])
• 2022-01-20 Hartmut new indexOfAnyCharOutsideQuotation(CharSequence, int, int, CharSequence, CharSequence, CharSequence, char, int[]) etc, handling quotations, here also (not only in StringPart, used for CmdExecuter.splitArgs(String, int, int)
• 2021-12-19 Hartmut bugfix comparePos(CharSequence, int, CharSequence, int, int): change on 2021-20-04 was wrong! The problem is, if the first char is different, it should not return 0, because that means equal. It should retunr 1 or -1 Because of that sometimes a bad directory was selected in Fcmd (a non exist new directory was detected as the last used).
• 2021-10-04 Hartmut new utf16toUTF8bytes(char, byte[], int) but also not tested and not used but may be correct.
• 2021-10-04 Hartmut rename @link utf8to16(byte[], int[]) instead link #byte2UTF8(byte[], int[])} but: this function is not tested and may be not used yet, may be not correct.
• 2021-10-04 Hartmut bugfix comparePos(CharSequence, int, CharSequence, int, int): return was one time to high.
• 2021-06-21 Hartmut bugfix comparePos(CharSequence, int, CharSequence, int, int) for comparing empty strings
• 2019-12-28 Hartmut new indexOfAnyChar(CharSequence, int, int, CharSequence, int[]) returns the number of the found character too
• 2019-06-08 Hartmut new: All StringFunctions with negative to argument, count from end, -1 is till end.
• *
• 2019-06-07 Hartmut new: as helper to find where is the difference, versus equals(CharSequence, int, int, CharSequence)
• 2016-12-02 Hartmut new: 4
• 2016-09-25 Hartmut new: nrofBytesUTF8(byte) used in StringPartFromFileLines
• 2016-05-22 Hartmut chg: indexOfAnyString(CharSequence, int, int, CharSequence[], int[], String[]): Algorithm from StringPart copied to here. It is common. temporary instance in StrinPart prevented.
• 2015-11-07 Hartmut chg: Now the number conversion routines are moved to StringFunctions_C. Reason: Dissipate the content because for some embedded applications a fine tuning of used sources is necessary.
• 2015-10-23 Hartmut new: indexWhitespace(CharSequence, int, int), indexNoWhitespace(CharSequence, int, int). indexAfterIdentifier(CharSequence, int, int, String)
• 2015-06-05 Hartmut chg: equals(CharSequence, int, int, CharSequence) regards null-pointer too.
• 2014-09-05 Hartmut new: Twice methods indexOf(CharSequence, int, int, String) and indexOf(CharSequence, int, int, CharSequence). Twice methods lastIndexOf(CharSequence, int, int, String) and lastIndexOf(CharSequence, int, int, CharSequence). The methods are the same in Java. But in C the handling of reference is different. In Java2C translation a StringJc does not base on CharSequence because it is a simple reference to char[] and a length only. CharSequence needs ObjectJc and virtual methods.
• 2014-05-04 Hartmut new: #indexOfAnyChar(CharSequence, int, int, String): Algorithm transfered from StringPart#indexOfAnyChar(String, int, int, char, char, char) to this class for common usage, called in StringPart. TODO do it with all that algoritm.
• 2014-05-04 Hartmut new cEndOfText now defined here, parallel to StringPart#cEndOfText. Note: that char is ASCII but not UTF.
• 2014-03-11 Hartmut new: indent2(int)
• 2013-09-07 Hartmut new: #parseFloat(String, int, int, char, int[]) with choiceable separator (123,45, german decimal point)
• 2013-09-07 Hartmut new: #convertTranscription(CharSequence, char) used form SpecialCharStrings#resolveCircumScription(String)
• 2013-08-29 Hartmut bugfix: compare(CharSequence, int, CharSequence, int, int), indexOf(CharSequence, CharSequence, int)
• 2013-08-10 Hartmut new: #parseIntRadix(String, int, int, int, int[], String) now can skip over some characters. In this kind a number like 2"123'456.1 is able to read.
• 2013-08-10 Hartmut new: #parseLong(String, int, int, int, int[], String) as counterpart to parseInt
• 2013-07-28 Hartmut new: isEmptyOrOnlyWhitespaces(CharSequence)
• 2013-05-04 Hartmut new some methods for usage CharSequence: compare(CharSequence, int, CharSequence, int, int), startsWith(CharSequence, CharSequence), endsWith(CharSequence, CharSequence), indexOf(CharSequence, char, int), indexOf(CharSequence, CharSequence, int) Generally usage of CharSequence as StringBuilder instance saves calculation time in comparison with usage String, because a new allocation is saved. This saving can be done any time if the StringBuilder is non thread-shared and its reference is not stored permanently but only used immediately in the thread.
• 2013-02-03 Hartmut new compare(CharSequence, CharSequence) and Object.equals(Object).
• 2012-08-22 Hartmut new copyToBuffer(String, char[]) and copyToBuffer(String, byte[], Charset): This methods are existent at the C-level. They are usefully if dynamic memory usage should be prevented. They are need for Java-usage with static data too.
• 2012-04-01 Hartmut new #parseIntRadix(String, int, int, int, int[]) etc. taken from C-Sources CRunntimeJavalike/source/Fwc/fw_Simple.c
• 2012-02-19 Hartmut created: basic functions also existent in C (Java2C-usage).

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

cEndOfText

public static final char cEndOfText

The char used to code end of text. It is defined in ASCII as EOT. In Unicode it is the same like , another meaning.

See Also:

Constant Field Values

cStartOfText

public static final char cStartOfText

The char used to code start of text.

See Also:

Constant Field Values

cNoCidentifier

public static final char cNoCidentifier

The char used to coding any char which is not an identifier character usual in programming languages like C, Java: A..Z a..z 0..9 _.

See Also:

Constant Field Values

indentString

static java.lang.String indentString

Constructor Detail

StringFunctions

public StringFunctions()

Method Detail

indexWhitespace

public static int indexWhitespace(java.lang.CharSequence src,
                                  int start,
                                  int endMax)

Searches the first whitespace in src from start till at maximal endMax. A whitespace is one of " \r\n\t\f"

Parameters:

src -

start -

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

Returns:

>=0: position in src of the first space from start, -1 if not found in range.

indexNoWhitespace

public static int indexNoWhitespace(java.lang.CharSequence src,
                                    int start,
                                    int endMax)

Searches the first non-whitespace in src from start till at maximal endMax. A whitespace is one of " \r\n\t\f"

Parameters:

src -

start -

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

Returns:

>=0: position in src of the first non space from start, -1 if not found in range.

indexIdentifier

public static int indexIdentifier(java.lang.CharSequence src,
                                  int start,
                                  int endMax,
                                  java.lang.String additionalStartChars)

Searches the position of the first identifier character starting from the given position. If the given position is on an identifier start character, it will be returned without change.

Parameters:

src -

start -

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

additionalStartChars - null: do not use,

Returns:

-1 if an identifier is not found. Elsewhere it is the position of the following identifier character.

indexAfterIdentifierOld

@Deprecated
public static int indexAfterIdentifierOld(java.lang.CharSequence src,
                                                       int start,
                                                       int endMax,
                                                       java.lang.String additionalChars)

Deprecated.

Returns the position after the end of an identifier. Note: An identifier usual never starts with 0..9. But this routine assumes that it is an identifier. It means starting with 0..9 should be detected and processed outside. If this src starts with 0..9 it is accepted here.

Parameters:

src - The input string

start - at this position the identifier starts.

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

additionalChars - maybe null, some chars as additional chars of an identifier, inside and as start.

Returns:

0 if src[start] doesn't match to an identifier character, number of found identifier chars after src until end.

indexAfterIdentifier

public static int indexAfterIdentifier(java.lang.CharSequence src,
                                       int start,
                                       int endMax,
                                       java.lang.String additionalChars)

Returns the position after the end of an identifier.

Parameters:

src - If the first char on [start] is 0..9 it returns 0, it is not an identifier.

start - from this position

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

additionalChars - maybe null, some chars as additional chars of an identifier, inside and as start.

Returns:

0 if it is not start with an identifier start character. '0'..'9' is not an identifier start. elsewhere the number of chars which are identifier characters A..Z, a..z, _, 0..9 and the additionalChars

posAfterIdentifier

@Deprecated
public static int posAfterIdentifier(java.lang.CharSequence src,
                                                  int start,
                                                  int endMax,
                                                  java.lang.String additionalStartChars,
                                                  java.lang.String additionalChars)

Deprecated. use indexAfterIdentifier(CharSequence, int, int, String)

Returns the position of the end of an identifier.

Parameters:

src - The input string

start - at this position the identifier starts.

endq - max number of chars to check

additionalStartChars - maybe null, some chars as additional start chars of an identifier.

additionalChars - maybe null, some chars as additional chars of an identifier.

Returns:

0 if src[start] doesn't match to an identifier character, number of found identifier chars after src until end.

posAfterIdentifier

@Deprecated
public static int posAfterIdentifier(java.lang.CharSequence src,
                                                  int start,
                                                  int endMax)

Deprecated. use indexAfterIdentifier(CharSequence, int, int, String)

Returns the position of the end of an identifier.

Parameters:

src - The input string

start - at this position the indentier starts.

endq - max number of chars to check

Returns:

0 if src[start] doesn't match to an identifier character, number of found identifier chars after src until end.

copyToBuffer

public static int copyToBuffer(java.lang.String src,
                               byte[] buffer,
                               java.nio.charset.Charset encoding)

Copies the content of a String in the given byte buffer with the requested encoding. If this method is used in a C/C++ environment, it is programmed in a special maybe more simple way because not all encodings are supported. Usual a String is only a byte array itself, it is copied.

Parameters:

src - The src String

buffer - The desination buffer with given length. The last byte will be set to 0.

encoding - The encoding. If null, then use the UTF8-encoding.

Returns:

number of bytes in buffer.

copyToBuffer

public static int copyToBuffer(java.lang.String src,
                               char[] buffer)

Copies the content of a String in the given char buffer. If this method is used in a C/C++ environment, the char buffer may be a byte buffer really.

Parameters:

src - The src String

buffer - The desination buffer with given length. The last byte will be set to 0.

Returns:

number of chars in buffer.

z_StringJc

public static java.lang.String z_StringJc(char[] buffer)

Converts a String in a buffer in a java.lang.String.

Parameters:

buffer - It is zero-terminated.

Returns:

A String which contains all characters till the first '\0' or the whole buffer.

comparePos

public static int comparePos(java.lang.CharSequence s1,
                             java.lang.CharSequence s2)

Compares two CharSequence (Strings, StringBuilder-content etc. It is the adequate functionality like String.compareTo(String). but it works proper with CharSequence. See example on Object.equals(Object).

Parameters:

s1 - left char sequence

s2 - right char sequence

Returns:

0 if all characters are equal, positive if the part of s1 > s2, negative if s1 < s2.
The absolute of return is the number of equal characters +1.
Note that the different character is charAt(returnValue -1) or the length of the shorter CharSeqence is returnVal -1. This convention is necessary because 0 means equal. It should be distinguish from the result charAt(0) is different.
-1 means, the first character is different whereby s1.charAt(0) < s2.charAt(0) or s1.length()==0 && s2.length() >0
1 means, the first character is different whereby s1.charAt(0) > s2.charAt(0) or s1.length() >= && s2.length()==0
The comparison of "abcx" with "abcy" results -4 because 'x' < 'y' on the position 3.
The comparison of "abc" with "abcy" results -4 because 'x' < 'y' on the position 3.

comparePos

public static int comparePos(java.lang.CharSequence s1,
                             int from1,
                             java.lang.CharSequence s2,
                             int from2,
                             int nrofChars)

Compares two CharSequence (Strings, StringBuilder-content etc.) It detects that position where the Strings are different. That is not done by String.compareTo(String) or compare(CharSequence, int, CharSequence, int, int)

Parameters:

s1 - left char sequence

from1 - start position

s2 - right char sequence

from2 - start position

nrofChars - maximal number of chars to compare. It can be negative or Integer.MAX_VALUE to compare all characters to the end. Use -1 to compare all characters is recommended. Note: if 0, the return value of this method is 0 because all (=0) characters are equal. This may be important for some extrem situations.

Returns:

0 if all characters are equal, positive if the part of s1 > s2, negative if s1 < s2.
The absolute of return is the number of equal characters +1.
Note that the different character is charAt(returnValue -1) or the length of the shorter CharSeqence is returnVal -1. This convention is necessary because 0 means equal. It should be distinguish from the result charAt(0) is different.
-1 means, the first character is different whereby s1.charAt(0) < s2.charAt(0) or s1.length()==0 && s2.length() >0
1 means, the first character is different whereby s1.charAt(0) > s2.charAt(0) or s1.length() >= && s2.length()==0
The comparison of "abcx" with "abcy" results -4 because 'x' < 'y' on the position 3.
The comparison of "abc" with "abcy" results -4 because 'x' < 'y' on the position 3.

compareWhSpacePos

public static int compareWhSpacePos(java.lang.CharSequence s1,
                                    int from1,
                                    int to1,
                                    java.lang.CharSequence s2,
                                    int from2,
                                    int to2,
                                    int[] p2Out)

Compare two Strings whereby white spaces are ignored. This is ideal for test results where white spaces are non relevant for the results.

Parameters:

s1 - Any string, can be null

from1 - start position

to1 - -1 then till end, -2... before end, positive: number of chars

s2 - Second String

from2 -

to2 -

p2Out - null or an int[1] variable for the error position in s2

Returns:

0 if both are equal, >=1 if s1 is alphabetic greater or longer, <=-1 if s1 is lesser or shorter. The return value is the error position +1. Errror on start position is 1 (to distinguish from 0 = ok. )

test

boolean test(java.lang.String s)

compare

public static int compare(java.lang.CharSequence s1,
                          int from1,
                          java.lang.CharSequence s2,
                          int from2,
                          int nrofChars)

Compares two CharSequence (Strings, StringBuilder-content etc. It is the adequate functionality like String.compareTo(String). but it works proper with CharSequence. See example on Object.equals(Object).

Parameters:

s1 - left char sequence, maybe null, then return -1 or 0 (both null)

from1 - start position

s2 - right char sequence, maybe null, then return 0 (both null) or 1.

from2 - start position

nrofChars - maximal number of chars to compare. It can be Integer.MAX_VALUE to compare all characters to the end.

Returns:

0 if all characters are equal, 1 if the part of s1 > s2, -1 if s1 < s2.

compare

public static int compare(java.lang.CharSequence s1,
                          java.lang.CharSequence s2)

Compares two Strings or StringBuilder-content or any other CharSequence. It is the adequate functionality like String.compareTo(String).

Parameters:

s1 -

s2 -

Returns:

0 if all characters are equal, 1 if s1 > s2, -1 if s1 < s2

equals

public static boolean equals(java.lang.CharSequence s1,
                             int from,
                             int to,
                             java.lang.CharSequence s2)

Compares two charsequences. It is similar String.equals(String), but works with CharSequence and accepts null-pointer.

Parameters:

s1 - first, if null then returns true if s2== null. Equals is both null too.

from - start position in s1

to - exclusive end position in s1, if <0, especially -1 or > s1.length, then till length of s1. That is 'endsWith'.

s2 - to compare with

Returns:

true if all chars equals or both null.

compareChars

public static int compareChars(java.lang.CharSequence s1,
                               int from,
                               int to,
                               java.lang.CharSequence s2)

Compare two character Strings. It returns the position of non equal character. Therefore it has some more calculation time then equals.

Returns:

>=0 number of chars which are equal, -1: all are equal and the length are equal.

equals

public static boolean equals(java.lang.CharSequence s1,
                             java.lang.CharSequence s2)

Compares two Strings or StringBuilder-content or any other CharSequence. It is the adequate functionality like String.equals(Object). But the String.equals(Object) does only compare instances of Strings, it does not compare a String with any other CharSequence whether there are equal. Not that:

 String str = "abc";
 String str2 = "abc";
 StringBuilder sb = new StringBuilder(str);
 assert(str.equals(str2));
 assert(str.contentEquals(sb));  //special String comparator
 assert( ! str.equals(sb));      //it is not equals, sb is not a String.
 assert(StringFunctions.equals(str, sb));
 assert(StringFunctions.equals(sb, str)); //compares any CharSequences
 

Parameters:

s1 -

s2 -

Returns:

0 if all characters are equal, 1 if s1 > s2, -1 if s1 < s2

contains

public static boolean contains(java.lang.CharSequence s1,
                               java.lang.CharSequence s2)

Returns true if s2 is contained in s1. It invokes indexOf(CharSequence, int, int, CharSequence).

startsWith

public static boolean startsWith(java.lang.CharSequence sq,
                                 java.lang.CharSequence start)

Checks whether the given CharSequence starts with a defined CharSequence. It is the adequate functionality like String.startsWith(String) but it works proper with CharSequence. See example on Object.equals(Object).

startsWithAfterAnyChar

public static int startsWithAfterAnyChar(java.lang.CharSequence sq,
                                         java.lang.CharSequence start,
                                         java.lang.String anyCharBeforeStart)

Checks whether a given sq starts with the compare sequence start, but after some admissible characters.

Parameters:

sq - The string to check

start - start characters to check

anyCharBeforeStart - often only one space, or specific indent character.

Returns:

-1 if not starts with start, else position after the start string.

startsWith

public static boolean startsWith(java.lang.CharSequence sq,
                                 int from,
                                 int endMax,
                                 java.lang.CharSequence start)

Checks whether the given CharSequence starts with a CharSequence. It is the adequate functionality like String.startsWith(String) but it works proper with CharSequence. See example on Object.equals(Object).

Parameters:

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

endsWith

public static boolean endsWith(java.lang.CharSequence sq,
                               java.lang.CharSequence end)

Checks whether the given CharSequence ends with a CharSequence. It is the adequate functionality like String.startsWith(String) but it works proper with CharSequence. See example on Object.equals(Object).

isEmptyOrOnlyWhitespaces

public static boolean isEmptyOrOnlyWhitespaces(java.lang.CharSequence text)

Returns false if at least one char was found in text which is not a whitespace. A whitespace is one of " \t\n\r"

Parameters:

text - to check

Returns:

true if text is empty or contains only whitespaces.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          int fromIndex,
                          int to,
                          char ch)

Searches the first occurrence of the given character in a CharSequence. It is the adequate functionality like java.lang.String#indexOf(char, int).

Parameters:

sq - search into

fromIndex - start search

to - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

ch - The character which is searched.

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          char ch,
                          int fromIndex)

Searches the first occurrence of the given Character in a CharSequence. It is the adequate functionality like String.indexOf(String, int).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

fromIndex - first checked position in sq

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          char ch)

Searches the first occurrence of the given Character in a CharSequence. It is the adequate functionality like String.indexOf(String).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

indexOfAnyChar

public static int indexOfAnyChar(java.lang.CharSequence sq,
                                 int begin,
                                 int endMax,
                                 java.lang.CharSequence sChars,
                                 int[] nr)

Searches any char inside sChars in the given CharSequence.

Parameters:

sq - The String to search in

begin - start position to search in sq

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

sChars - Some chars to search in sq If sChars contains a EOT character (code 03, cEndOfText) then the search stops at this character or it is continued to the end of the range in sq. Then the length of the text range is returned if another character in sChars is not found. It means: The end of the text range is adequate to an EOT-character. Note that EOT is not unicode, but it is an ASCII control character.

nr - null or initialized with new int[1], then returns the number of the found character in sChars from 0

Returns:

The first position in sq of one of the character in sChars or -1 if not found in the given range.

indexAfterAnyChar

public static int indexAfterAnyChar(java.lang.CharSequence sq,
                                    int begin,
                                    int endMax,
                                    java.lang.CharSequence sChars)

Searches the first character which is not contains in any given characters.

Parameters:

sq - search this string

begin - >=0 for start

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

sChars - This characters are skipped

Returns:

position of the first character which is not contained in sChars or the length if to whole string contains only chars from sChars.

skipOverQuotation

private static int skipOverQuotation(java.lang.CharSequence sq,
                                     int pos,
                                     int endMax,
                                     char cc,
                                     java.lang.CharSequence sQuotChars,
                                     java.lang.CharSequence sQuotEndChars,
                                     int zQu,
                                     char transcriptChar)

Only internal used. Used to check

Parameters:

sq -

pos - current, maybe a quotation or not, this operation tests it.

endMax -

cc - character on sq[pos]

sQuotChars - maybe null

sQuotEndChars - maybe null

zQu -

transcriptChar -

Returns:

Position of the end character of the found quotation or unchanged pos.

indexOutsideQuotation

public static int indexOutsideQuotation(java.lang.CharSequence sq,
                                        int begin,
                                        int endMax,
                                        char csearch,
                                        java.lang.CharSequence sQuotChars,
                                        java.lang.CharSequence sQuotEndChars,
                                        char transcriptChar)

Searches the first occurrence of the given character in a CharSequence whereby characters in quotation are not checked. It is an enhancement in functionality of indexOf(CharSequence, char) or adequate java.lang.String#indexOf(char, int) but regarding quotation.

Parameters:

sq - search into

begin - start search

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

csearch - The character which is searched.

sQuotChars - null or List of possible start quotation character, for example "\"'"

sQuotEndChars - null or List of associated end quotation character. If null then the same as start character are used (familiar for "")

transcriptChar - Character after this char is not checked, usual \ for transcription of \", \n etc.

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

indexOfAnyCharOutsideQuotation

public static int indexOfAnyCharOutsideQuotation(java.lang.CharSequence sq,
                                                 int begin,
                                                 int endMax,
                                                 java.lang.CharSequence sChars,
                                                 java.lang.CharSequence sQuotChars,
                                                 java.lang.CharSequence sQuotEndChars,
                                                 char transcriptChar,
                                                 int[] nr)

Searches the first occurrence of some given characters in a CharSequence whereby characters in quotation are not checked. It is an enhancement in functionality of indexOf(CharSequence, char) or adequate java.lang.String#indexOf(char, int) but regarding quotation.

Parameters:

sq - search into

begin - start search

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

sChars - Some characters which are searched.

sQuotChars - null or List of possible start quotation character, for example "\"'"

sQuotEndChars - null or List of associated end quotation character. If null then the same as start character are used (familiar for "")

transcriptChar - Character after this char is not checked, usual \ for transcription of \", \n etc.

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

indexOfAnyChar

public static int indexOfAnyChar(java.lang.CharSequence sq,
                                 int begin,
                                 int endMax,
                                 java.lang.CharSequence sChars)

Searches any char inside sChars in the given Charsequence

Parameters:

begin - start position to search in sq

endMax - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

sChars - Some chars to search in sq If sChars contains a EOT character (code 03, cEndOfText) then the search stops at this character or it is continued to the end of the range in sq. Then the length of the text range is returned if another character in sChars is not found. It means: The end of the text range is adequate to an EOT-character. Note that EOT is not unicode, but it is an ASCII control character.

Returns:

The first position in sq of one of the character in sChars or -1 if not found in the given range.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence sq,
                              int from,
                              int end,
                              char ch)

Searches the last occurrence of the given char in a CharSequence. It is the adequate functionality like java.lang.String#lastIndexOf(char, fromEnd).

Parameters:

sq - Any sequence

from - range, it ends searching on from

end - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

ch - to search

Returns:

-1 if not found, elsewhere the position inside sq, >=fromIndex and < to

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence sq,
                              char ch)

Searches the last occurrence of the given char in a CharSequence. It is the adequate functionality like java.lang.String#lastIndexOf(char).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

Returns:

-1 if not found, else first occurrence where sq.charAt(return) == ch.

lastIndexOfAnyChar

public static int lastIndexOfAnyChar(java.lang.CharSequence sq,
                                     int from,
                                     int to,
                                     java.lang.CharSequence chars)

Searches the last occurrence of one of the given chars in a CharSequence.

Parameters:

sq - Any sequence

from - range, it ends searching on from if from < 0 it throws IndexOutOfBoundsException

to - start backward from here if > sq.length() starts from end as well as to = -1 if to < from then returns -1 always. if to < 0 then starts from end - to, use to = -1 to start from end to = -2 to start one for end

chars - to search for

Returns:

-1 if not found, elsewhere the position inside sq, >=fromIndex and < to

Throws:

java.lang.IndexOutOfBoundsException - if from < 0 or to < 0

lastIndexOfNoChar

public static int lastIndexOfNoChar(java.lang.CharSequence sq,
                                    int from,
                                    int to,
                                    java.lang.CharSequence chars)

Searches the last occurrence in a CharSequence of any char which is not given in chars.

Parameters:

sq - Any sequence

from - range, it ends searching on from if from < 0 it throws IndexOutOfBoundsException

to - start backward from here if > sq.length() starts from end as well as to = -1 if to < from then returns -1 always. if to < 0 then starts from end - to, use to = -1 to start from end to = -2 to start one for end

chars - to search for, for example " \t\n\r" to search the last non-whitespace chararcter

Returns:

-1 if not found, elsewhere last position inside sq, >=fromIndex and < to which is not a char from chars

Throws:

java.lang.IndexOutOfBoundsException - if from < 0 or to < 0

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          int fromIndex,
                          int to,
                          java.lang.String str)

Checks whether the given CharSequence contains the other given CharSequence. It is the adequate functionality like String.indexOf(String, int).

Parameters:

sq - A CharSequence

fromIndex - first checked position in sq

to - >=0 then end position of checked range inclusive str to <0 then relative position from end. to = -1 exact till end

str - which is searched.

Returns:

-1 if not found, else first occurrence of str in sq which is >= fromIndex.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          int fromIndex,
                          int to,
                          java.lang.CharSequence str)

Checks whether the given CharSequence contains the other given CharSequence. It is the adequate functionality like String.indexOf(String, int).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

fromIndex - first checked position in sq

to - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

Returns:

-1 if not found, else first occurrence of str in sq which is >= fromIndex.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          java.lang.CharSequence str,
                          int fromIndex)

Searches the first occurrence of the given CharSequence in a CharSequence. It is the adequate functionality like String.indexOf(String, int).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

fromIndex - first checked position in sq

Returns:

-1 if not found, else first occurrence where equals(CharSequence sq, int return , int MAX_VALUE, CharSequence str) ==0.

indexOf

public static int indexOf(java.lang.CharSequence sq,
                          java.lang.CharSequence str)

Searches the first occurrence of the given CharSequence in a CharSequence. It is the adequate functionality like String.indexOf(String).

Parameters:

sq - A CharSequence

str - CharSequence which is searched.

Returns:

-1 if not found, else first occurrence where equals(CharSequence sq, int return , int MAX_VALUE, CharSequence str) ==0.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence sq,
                              int fromIndex,
                              int to,
                              java.lang.String str)

Checks whether the given CharSequence contains the given String. It is the adequate functionality like String.lastIndexOf(String, int).

Parameters:

sq - Any sequence where to search in

from - range, it ends searching on from

to - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

str - comparison String, check whether contained fully.

Returns:

-1 if not found, elsewhere the position inside sq >=fromIndex and <= to - str.length()

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence sq,
                              int fromIndex,
                              int to,
                              java.lang.CharSequence str)

Checks whether the given CharSequence contains the other given CharSequence. Note: The algorithm and source lines are the same like in #lastIndexOfAnyChar(CharSequence, int, int, String). The difference is by translating to C source.

Parameters:

sq - Any sequence where to search in

from - range, it ends searching on from

to - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

str - comparison sequence, check whether contained fully.

Returns:

-1 if not found, elsewhere the position inside sq >=fromIndex and <= to - str.length()

indexOfAnyString

public static int indexOfAnyString(java.lang.CharSequence sq,
                                   int from,
                                   int to,
                                   java.lang.CharSequence[] listStrings,
                                   int[] nrofFoundString,
                                   java.lang.String[] foundString)

Returns the position of one of the strings in listStrings within the given sq, maybe started inside the sq with from, returns -1 if the char is not found in the part started from 'fromIndex'.

Parameters:

from - begin of search within the part.

to - >=0: absolute exclusive end position for search, <0: end position relative to end, -1 is the end of src

listStrings - contains some Strings to find.

nrofFoundString - If given, [0] is set with the number of the found String in listStrings, count from 0. This array reference may be null, then unused.

foundString - If given, [0] is set with the found String. This array reference may be null.

Returns:

either -1 if not found, or position of first founded char inside sq in range from..to

convertTransliteration

public static java.lang.CharSequence convertTransliteration(java.lang.CharSequence src,
                                                            char transcriptChar)

Resolves the given String containing some transcription chars (usual backslash) to a string with the appropriate character codes. In the result String all char-pairs beginning with the transciptionChar are replaced by one char. If the String doesn't contain a transcriptChar, the method returns the input string in a as soon as possible calculation time.

• The transcript char following by n r t f b will converted to the known control character codes:
• \n newline 0x0a
• etc TODO
• \s will converted to a single space. It is useful in input situations where a space will have another effect.
• \a will converted to the code 0x02, known in this class cStartOfText. It is useful wether a String may be contain a code for start of text.
• \e will converted to the code 0x03, known in this class cEndOfText.
• \x0123 Convert from given hex code TODO
• \\ is the backslash itself.
• All other chars after the transcription char will be converted to the same char, for example "\{" to "{". Don't use this feature for normal alphabetic chars because some extensions in a future may be conflict with them. But this feature may be useful if an input text uses the special characters in a special way.

Parameters:

src - The input string

transcriptChar - the transcript character, usual a '\\'

Returns:

The output string with replaces backslash pairs. It is a non-referenced StringBuilder if the src contains transcription chars, it is src itself if src does not contain transcription chars.

indent2

public static java.lang.String indent2(int indent)

Returns a String with 2*indent spaces for indentation. If indent is >50, return only 100 spaces.

Parameters:

indent - indentation

Returns:

nl_indent2

public static java.lang.String nl_indent2(int indent)

Returns a String with a newline \n character and 2*indent spaces for indentation. If indent is >50, return only 100 spaces.

Parameters:

indent - indentation

Returns:

nrofBytesUTF8

public static int nrofBytesUTF8(byte b)

Returns the number of bytes to the UTF start byte.

• 0x00..0x7f: 1 byte UTF8. First byte contains 7 bit. Result 7 bit.
• 0x80..0xbf: It is any second byte of a UTF8 stream. This routine returns 0. Any following byte contains 6 bit.
• 0xc0..0xdf: 2 byte UTF8. First byte contains 5 bit. Result 12 bit. 0x0fff..0x0
• 0xef..0xe0: 3 byte UTF8. First byte contains 4 bit. Result 16 bit 0xffff..0, This it the range of UTF-16
• 0xf7..0xf0: 4 byte UTF8. First byte contains 3 bit. Result 21 bit
• 0xfb..0xf8: 5 byte UTF8. First byte contains 2 bit. Result 26 bit
• 0xfd..0xfc: 6 byte UTF8. First byte contains 1 bit. Result 31 bit
• 0xfe: 7 byte UTF8. First byte contains 0 bit. Result 36 bit
• 0xff: 8 byte UTF8. First byte contains 0 bit. Result 42 bit
• The first byte does not have the bits 10xx xxxx (range 0x80..0xbf). Then return 0, the ixSrc[0] will not be incremented.

Parameters:

b - any byte of a UTF8 stream.

Returns:

1..8 for a valid UTF8 start character. 0 for a character which is not a start character.

byte2UTF8

public static short byte2UTF8(byte[] src,
                              int[] ixSrc)

Converts the current bytes in a byte[] from UTF-8 in a UTF16-character.

Parameters:

src -

ixSrc -

Returns:

utf8to16

public static short utf8to16(byte[] src,
                             int[] ixSrc)

Converts the current bytes in a byte[] from UTF-8 in a UTF16-character.
Special code error situations:

• The first byte does not have the bits 10xx xxxx (range 0x80..0xbf). Then return 0, the ixSrc[0] will not be incremented.
• The following bytes must have the bits 10xx xxxx. If not, then return 0 with the ixSrc[0] on the position of the errorneous byte.
• Characters outside UTF16: The character (short)(0xfffd) is returned, but the bytes are correctly skipped, so the next character start byte is referred by the ixSrc[0].

If that error occurs, the routine returns 0 and the ixDst[0] refers the faulty byte. With comparison with the start index before invocation, the error can be ...TODO

Parameters:

src - any byte array

ixSrc - [0] The current position in this byte array. It should refer the first byte of a UTF-8-coded character. The ixSrc[0] will be incremented by the processed bytes for this one character. If the routine does not return 0, than the ixSrc[0] refers the first byte of the next UTF8 character, or the end of the array.

Returns:

the character from the read UTF-8 code bytes. It is returned as short (or int16 in C). It can be casted to char for Java applications. For C programming the handling of UTF16 is a special case. Special cases: return 0 if byte[ixSrc[0]] does not contain a valid UTF-8 code sequence.

utf16toUTF8bytes

int utf16toUTF8bytes(char cc,
                     byte[] buffer,
                     int posBuffer)

Converts a UTF16 character to 1..3 bytes UTF8

Parameters:

cc - The character

buffer - for bytes

posBuffer - first write position in buffer. The buffer size should be at least posBuffer +3

Returns:

number of written bytes. See https://en.wikipedia.org/wiki/UTF-8, https://de.wikipedia.org/wiki/UTF-8