StringTools (LanguageTool 6.4-SNAPSHOT API)

java.lang.Object
- org.languagetool.tools.StringTools

```
public final class StringTools
extends Object
```
Tools for working with strings.

Author:

Daniel Naber

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StringTools.ApiPrintMode
Constants for printing XML rule matches.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringTools.ApiPrintMode` Constants for printing XML rule matches.

Field Summary

Fields
Modifier and Type Field and Description

static Set<String> LOWERCASE_GREEK_LETTERS

static Set<String> UPPERCASE_GREEK_LETTERS

Fields
Modifier and Type	Field and Description
`static Set<String>`	`LOWERCASE_GREEK_LETTERS`
`static Set<String>`	`UPPERCASE_GREEK_LETTERS`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`addSpace(String word, Language language)` Adds spaces before words that are not punctuation.
`static String`	`asString(CharSequence s)`
`static void`	`assureSet(String s, String varName)` Throw exception if the given string is null or empty or only whitespace.
`static String`	`escapeForXmlAttribute(String s)`
`static String`	`escapeForXmlContent(String s)`
`static String`	`escapeHTML(String s)` Escapes these characters: less than, greater than, quote, ampersand.
`static String`	`escapeXML(String s)` Calls `escapeHTML(String)`.
`static String`	`filterXML(String str)` Simple XML filtering for XML tags.
`static List<String>`	`getDifference(String s1, String s2)` Difference between two strings (only one difference)
`static boolean`	`hasDiacritics(String str)`
`static boolean`	`isAllUppercase(List<String> strList)` Returns true if the given list of string is made up of all-uppercase words.
`static boolean`	`isAllUppercase(String str)` Returns true if the given string is made up of all-uppercase characters (ignoring characters for which no upper-/lowercase distinction exists).
`static boolean`	`isCamelCase(String token)` Whether the string is camelCase.
`static boolean`	`isCapitalizedWord(String str)`
`static boolean`	`isEmpty(String str)` Helper method to replace calls to `"".equals()`.
`static boolean`	`isMixedCase(String str)` Returns true if the given string is mixed case, like `MixedCase` or `mixedCase` (but not `Mixedcase`).
`static boolean`	`isNonBreakingWhitespace(String str)` Checks if a string is the non-breaking whitespace ( ).
`static boolean`	`isNotAllLowercase(String str)` Returns true if `str` is not made up of all-lowercase characters (ignoring characters for which no upper-/lowercase distinction exists).
`static boolean`	`isNotWordCharacter(String input)` Whether the string is a punctuation mark
`static boolean`	`isNotWordString(String input)`
`static boolean`	`isParagraphEnd(String sentence, boolean singleLineBreaksMarksPara)`
`static boolean`	`isPositiveNumber(char ch)`
`static boolean`	`isPunctuationMark(String input)` Whether the string is a punctuation mark
`static boolean`	`isWhitespace(String str)` Checks if a string contains a whitespace, including: all Unicode whitespace the non-breaking space (U+00A0) the narrow non-breaking space (U+202F) the zero width space (U+200B), used in Khmer
`static List<String>`	`loadLines(String path)` Deprecated. use DataBroker#getFromResourceDirAsLines(java.lang.String) instead (NOTE: it won't handle comments)
`static String`	`lowercaseFirstChar(String str)` Return `str` modified so that its first character is now an lowercase character.
`static String`	`lowercaseFirstCharIfCapitalized(String str)` Return `str` if str is capitalized `isCapitalizedWord(String)`, otherwise return modified `str` so that its first character is now a lowercase character.
`static String`	`makeWrong(String s)`
`static String`	`normalizeNFC(String str)`
`static String`	`normalizeNFKC(String str)`
`static String`	`preserveCase(String inputString, String modelString)` Apply to inputString the casing of modelString
`static String`	`readerToString(Reader reader)`
`static String`	`readStream(InputStream stream, String encoding)` Read the text stream using the given encoding.
`static String`	`removeDiacritics(String str)`
`static String`	`removeTashkeel(String str)` Return `str` without tashkeel characters
`static boolean`	`startsWithLowercase(String str)` Whether the first character of `str` is an uppercase character.
`static boolean`	`startsWithUppercase(String str)` Whether the first character of `str` is an uppercase character.
`static String`	`streamToString(InputStream is, String charsetName)`
`static String`	`toId(String input, Language language)` Will turn a string into a typical rule ID, i.e. uppercase and "_" instead of spaces.
`static String`	`trimSpecialCharacters(String s)` eliminate special (unicode) characters, e.g. soft hyphens
`static String`	`trimWhitespace(String s)` Filters any whitespace characters.
`static String`	`uppercaseFirstChar(String str)` Return `str` modified so that its first character is now an uppercase character.
`static String`	`uppercaseFirstChar(String str, Language language)` Like `uppercaseFirstChar(String)`, but handles a special case for Dutch (IJ in e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UPPERCASE_GREEK_LETTERS
```
public static final Set<String> UPPERCASE_GREEK_LETTERS
```
  - LOWERCASE_GREEK_LETTERS
```
public static final Set<String> LOWERCASE_GREEK_LETTERS
```
- Method Detail
  - assureSet
```
public static void assureSet(String s,
                             String varName)
```
    Throw exception if the given string is null or empty or only whitespace.
  - readStream
```
public static String readStream(InputStream stream,
                                String encoding)
                         throws IOException
```
    Read the text stream using the given encoding.
    
    Parameters:
    
    stream - InputStream the stream to be read
    
    encoding - the stream's character encoding, e.g. utf-8, or null to use the system encoding
    
    Returns:
    
    a string with the stream's content, lines separated by \n (note that \n will be added to the last line even if it is not in the stream)
    
    Throws:
    
    IOException
    
    Since:
    
    2.3
  - isAllUppercase
```
public static boolean isAllUppercase(String str)
```
    Returns true if the given string is made up of all-uppercase characters (ignoring characters for which no upper-/lowercase distinction exists).
  - isAllUppercase
```
public static boolean isAllUppercase(List<String> strList)
```
    Returns true if the given list of string is made up of all-uppercase words. If the list contains only numbers or punctuation marks it is not considered all-uppercase
  - isMixedCase
```
public static boolean isMixedCase(String str)
```
    Returns true if the given string is mixed case, like MixedCase or mixedCase (but not Mixedcase).
    
    Parameters:
    
    str - input str
  - isNotAllLowercase
```
public static boolean isNotAllLowercase(String str)
```
    Returns true if str is not made up of all-lowercase characters (ignoring characters for which no upper-/lowercase distinction exists).
    
    Since:
    
    2.5
  - isCapitalizedWord
```
@Contract(value="null -> false")
public static boolean isCapitalizedWord(@Nullable
                                                                         String str)
```
    Parameters:
    
    str - input string
    
    Returns:
    
    true if word starts with an uppercase letter and all other letters are lowercase
  - startsWithUppercase
```
public static boolean startsWithUppercase(String str)
```
    Whether the first character of str is an uppercase character.
  - startsWithLowercase
```
public static boolean startsWithLowercase(String str)
```
    Whether the first character of str is an uppercase character.
    
    Since:
    
    4.9
  - uppercaseFirstChar
```
@Contract(value="!null -> !null")
 @Nullable
public static String uppercaseFirstChar(@Nullable
                                                                                     String str)
```
    Return str modified so that its first character is now an uppercase character. If str starts with non-alphabetic characters, such as quotes or parentheses, the first character is determined as the first alphabetic character.
  - uppercaseFirstChar
```
@Contract(value="!null, _ -> !null")
 @Nullable
public static String uppercaseFirstChar(@Nullable
                                                                                        String str,
                                                                                        Language language)
```
    Like uppercaseFirstChar(String), but handles a special case for Dutch (IJ in e.g. "ijsselmeer" -> "IJsselmeer").
    
    Parameters:
    
    language - the language, will be ignored if it's null
    
    Since:
    
    2.7
  - lowercaseFirstChar
```
@Contract(value="!null -> !null")
 @Nullable
public static String lowercaseFirstChar(@Nullable
                                                                                     String str)
```
    Return str modified so that its first character is now an lowercase character. If str starts with non-alphabetic characters, such as quotes or parentheses, the first character is determined as the first alphabetic character.
  - lowercaseFirstCharIfCapitalized
```
@Contract(value="!null, -> !null")
 @Nullable
public static String lowercaseFirstCharIfCapitalized(@Nullable
                                                                                                   String str)
```
    Return str if str is capitalized isCapitalizedWord(String), otherwise return modified str so that its first character is now a lowercase character.
  - readerToString
```
public static String readerToString(Reader reader)
                             throws IOException
```
    Throws:
    
    IOException
  - streamToString
```
public static String streamToString(InputStream is,
                                    String charsetName)
                             throws IOException
```
    Throws:
    
    IOException
  - escapeXML
```
public static String escapeXML(String s)
```
    Calls escapeHTML(String).
  - escapeForXmlAttribute
```
public static String escapeForXmlAttribute(String s)
```
    Since:
    
    2.9
  - escapeForXmlContent
```
public static String escapeForXmlContent(String s)
```
    Since:
    
    2.9
  - escapeHTML
```
public static String escapeHTML(String s)
```
    Escapes these characters: less than, greater than, quote, ampersand.
  - trimWhitespace
```
public static String trimWhitespace(String s)
```
    Filters any whitespace characters. Useful for trimming the contents of token elements that cannot possibly contain any spaces, with the exception for a single space in a word (for example, if the language supports numbers formatted with spaces as single tokens, as Catalan in LanguageTool).
    
    Parameters:
    
    s - String to be filtered.
    
    Returns:
    
    Filtered s.
  - trimSpecialCharacters
```
public static String trimSpecialCharacters(String s)
```
    eliminate special (unicode) characters, e.g. soft hyphens
    
    Parameters:
    
    s - String to filter
    
    Returns:
    
    s, with non-(alphanumeric, punctuation, space) characters deleted
    
    Since:
    
    4.3
  - addSpace
```
public static String addSpace(String word,
                              Language language)
```
    Adds spaces before words that are not punctuation.
    
    Parameters:
    
    word - Word to add the preceding space.
    
    language - Language of the word (to check typography conventions). Currently French convention of not adding spaces only before '.' and ',' is implemented; other languages assume that before ,.;:!? no spaces should be added.
    
    Returns:
    
    String containing a space or an empty string.
  - isWhitespace
```
public static boolean isWhitespace(String str)
```
    Checks if a string contains a whitespace, including:
    - all Unicode whitespace
    - the non-breaking space (U+00A0)
    - the narrow non-breaking space (U+202F)
    - the zero width space (U+200B), used in Khmer
    Parameters:
    
    str - String to check
    
    Returns:
    
    true if the string is a whitespace character
  - isNonBreakingWhitespace
```
public static boolean isNonBreakingWhitespace(String str)
```
    Checks if a string is the non-breaking whitespace ( ).
    
    Since:
    
    2.1
  - isPositiveNumber
```
public static boolean isPositiveNumber(char ch)
```
    Parameters:
    
    ch - Character to check
    
    Returns:
    
    True if the character is a positive number (decimal digit from 1 to 9).
  - isEmpty
```
public static boolean isEmpty(@Nullable
                              String str)
```
    Helper method to replace calls to "".equals().
    
    Parameters:
    
    str - String to check
    
    Returns:
    
    true if string is empty or null
  - filterXML
```
public static String filterXML(String str)
```
    Simple XML filtering for XML tags.
    
    Parameters:
    
    str - XML string to be filtered.
    
    Returns:
    
    Filtered string without XML tags.
  - hasDiacritics
```
public static boolean hasDiacritics(String str)
```
  - removeDiacritics
```
public static String removeDiacritics(String str)
```
  - normalizeNFKC
```
public static String normalizeNFKC(String str)
```
  - normalizeNFC
```
public static String normalizeNFC(String str)
```
  - preserveCase
```
public static String preserveCase(String inputString,
                                  String modelString)
```
    Apply to inputString the casing of modelString
    
    Parameters:
    
    inputString, - modelString
    
    Returns:
    
    string
  - asString
```
@Nullable
public static String asString(CharSequence s)
```
  - isParagraphEnd
```
public static boolean isParagraphEnd(String sentence,
                                     boolean singleLineBreaksMarksPara)
```
    Since:
    
    4.3
  - loadLines
```
public static List<String> loadLines(String path)
```
    Deprecated. use DataBroker#getFromResourceDirAsLines(java.lang.String) instead (NOTE: it won't handle comments)
    
    Loads file, ignoring comments (lines starting with #).
    
    Parameters:
    
    path - path in resource dir
    
    Since:
    
    4.6
  - toId
```
public static String toId(String input,
                          Language language)
```
    Will turn a string into a typical rule ID, i.e. uppercase and "_" instead of spaces. All non-ASCII characters are replaced with "_", EXCEPT for Latin-1 ranges U+00C0-U+00D6 and U+00D8-U+00DE. "de" locales have a special implementation (ä => ae, etc.).
    
    Parameters:
    
    language - LT language object, used to apply language-specific normalisation rules.
    
    Since:
    
    5.1
  - isCamelCase
```
public static boolean isCamelCase(String token)
```
    Whether the string is camelCase. Works only with ASCII input and with single words.
    
    Since:
    
    5.3
  - isPunctuationMark
```
public static boolean isPunctuationMark(String input)
```
    Whether the string is a punctuation mark
    
    Since:
    
    5.5
  - isNotWordCharacter
```
public static boolean isNotWordCharacter(String input)
```
    Whether the string is a punctuation mark
    
    Since:
    
    6.1
  - getDifference
```
public static List<String> getDifference(String s1,
                                         String s2)
```
    Difference between two strings (only one difference)
    
    Since:
    
    6.2
  - makeWrong
```
public static String makeWrong(String s)
```
  - removeTashkeel
```
public static String removeTashkeel(String str)
```
    Return str without tashkeel characters
    
    Parameters:
    
    str - input str
  - isNotWordString
```
public static boolean isNotWordString(String input)
```

Class StringTools

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UPPERCASE_GREEK_LETTERS

LOWERCASE_GREEK_LETTERS

Method Detail

assureSet

readStream

isAllUppercase

isAllUppercase

isMixedCase

isNotAllLowercase

isCapitalizedWord

startsWithUppercase

startsWithLowercase

uppercaseFirstChar

uppercaseFirstChar

lowercaseFirstChar

lowercaseFirstCharIfCapitalized

readerToString

streamToString

escapeXML

escapeForXmlAttribute

escapeForXmlContent

escapeHTML

trimWhitespace

trimSpecialCharacters

addSpace

isWhitespace

isNonBreakingWhitespace

isPositiveNumber

isEmpty

filterXML

hasDiacritics

removeDiacritics

normalizeNFKC

normalizeNFC

preserveCase

asString

isParagraphEnd

loadLines

toId

isCamelCase

isPunctuationMark

isNotWordCharacter

getDifference

makeWrong

removeTashkeel

isNotWordString