StringUtil (sigma-component 2.09 API)

java.lang.Object
- com.articulate.sigma.StringUtil

```
public class StringUtil
extends Object
```
A utility class that defines static methods for common string manipulation operations.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`allCapsToSUMOID(String str)`
`static String`	`arrayListToSpacedString(ArrayList<String> al)` Convert an arbitrary string to a legal KIF identifier by substituting dashes for illegal characters.
`static String`	`asSUMORelationID(String str)`
`static String`	`concatN(String input, int n)` Returns a String formed from n concatenations of input.
`static boolean`	`containsNonAsciiChars(String str)`
`static String`	`decode(String input)` Returns a URL decoded String obtained from input, which is assumed to be a URL encoded String composed of characters in the default charset.
`static boolean`	`emptyString(Object s)`
`static String`	`encode(String input)` Returns a URL encoded String obtained from input, which is assumed to be a String composed of characters in the default charset.
`static String`	`encrypt(String input, String charset)` Converts input, which is assumed to belong to charset, to a base 64 representation, and then encrypts the result using the SHA algorithm.
`static String`	`escapeEscapeChars(String str)`
`static String`	`escapeQuoteChars(String str)`
`static String`	`fillString(String st, char fillchar, int totalLength, boolean prepend)` Fill a string with the desired character up to the totalLength.
`static String`	`filterHtml(String input)` Remove HTML from input string.
`static int`	`findBalancedParen(int pIndex, String st)` Find the parenthesis that balances the one in st at character pIndex
`static String`	`fromBase64(String input, String charset)` Given an input String encoded in base-64, decodes the String and returns the original form of input in charset.
`static String`	`getCharset()` Returns a String denoting a character encoding scheme.
`static String`	`getContents(File aFile)` Fetch the entire contents of a text file, and return it in a String.
`static String`	`getDateTime(String pattern)` Returns a date/time string corresponding to pattern.
`static String`	`getKifNamespaceDelimiter()` Returns the string used in SUO-KIF to separate a namespace prefix from the term it qualifies.
`static String`	`getLineSeparator()` Returns the default line separator token for the current runtime platform.
`static String`	`getLocalReferenceBaseName()`
`static String`	`getSafeNamespaceDelimiter()` Returns a "safe" alphanumeric ASCII string that can be substituted for the W3C or SUO-KIF string delimiting a namespace prefix from an unqualified term name.
`static String`	`getW3cNamespaceDelimiter()` Returns the string preferred by W3C to separate a namespace prefix from the term it qualifies.
`static String`	`indent(int num, String indentChars)`
`static boolean`	`isDigitString(String input)` Returns true if every char in input is a digit char, else returns false.
`static boolean`	`isLocalTermReference(String term)`
`static boolean`	`isNonEmptyString(Object obj)`
`static boolean`	`isNumeric(String input)`
`static boolean`	`isQuotedString(String input)` Returns true if input appears to be a quoted String, else returns false.
`static boolean`	`isStringWithSpaces(String input)` Returns true if input is a String containing some whitespace chars, else returns false.
`static boolean`	`isUri(String input)` Returns true if input appears to be a URI string, else returns false.
`static ArrayList`	`kifListToArrayList(String kifListAsString)` Returns a new ArrayList formed by extracting in order the top-level members of kifListAsString, which is assumed to be the String representation of a SUO-KIF (LISP) list.
`static String`	`kifToW3c(String term)`
`static void`	`main(String[] args)`
`static String`	`makeQuotedString(String input, char quoteChar)` Returns a new String formed by adding quoteChar to each end of input.
`static String`	`normalizeSpaceChars(String str)`
`static String`	`quote(String input)`
`static String`	`removeEnclosingChar(String s, int n, char c)` Removes n layers of balanced ASCII double-quote characters from each end of the String s, if any are present.
`static String`	`removeEnclosingCharPair(String s, int n, char c1, char c2)` Removes n layers of balanced characters from each end of the String s, if any are present.
`static String`	`removeEnclosingChars(String s, int n, char c)` Removes n layers of balanced characters from each end of the String s, if any are present.
`static String`	`removeEnclosingQuotes(String s)` Removes all balanced ASCII double-quote characters from each end of the String s, if any are present.
`static String`	`removeEscapedDoubleQuotes(String str)`
`static String`	`removeEscapedEscapes(String str)`
`static String`	`removeHTML(String sentence)` Remove HTML markup from a sentence.
`static String`	`removeInternalDoubleQuotes(String str)`
`static String`	`removePunctuation(String sentence)` Remove punctuation and contractions from a sentence.
`static String`	`removeQuoteEscapes(String str)`
`static File`	`renameFileIfExists(File f)` If the file f already exists, this method returns a new File object with a unique name formed by appending an integer.
`static String`	`replaceDateTime(String input)` If the input String contains the sequence {date}pattern{date}, replaces the first occurrence of this sequence with a UTC date/time string formatted according to pattern.
`static String`	`replaceNonAsciiChars(String str)`
`static String`	`replaceNonIdChars(String st)` Replace any character that isn't a valid KIF identifier character with a lower-case x.
`static String`	`replaceRepeatedDoubleQuotes(String str)`
`static String`	`replaceUnsafeNamespaceDelimiters(String input)` Replaces non-alphanumeric namespace delimiters in input with an alphanumeric form that can be handled by Vampire and other provers.
`static String`	`safeToKifNamespaceDelimiters(String input)` Replaces all occurrences of the "safe" namespace delimiter in input with the default KIF namespace delimiter, which might contain characters that are not acceptable to some provers.
`static void`	`setCharset(String charEncoding)` Sets the default value of CHARSET to charEncoding.
`static String`	`setKifNamespaceDelimiter(String str)` Sets to str the String used in SUO-KIF to separate a namespace prefix from the term it qualifies.
`static void`	`setLineSeparator(String separator)` Sets the default line separator token for the current runtime platform.
`static void`	`setLocalReferenceBaseName(String basename)`
`static String`	`setSafeNamespaceDelimiter(String str)` Sets to str the "safe" alphanumeric ASCII String value that can be substituted for the W3C or SUO-KIF string delimiting a namespace prefix from an unqualified term name.
`static String`	`setW3cNamespaceDelimiter(String str)` Sets to str the String token preferred by W3C to separate a namespace prefix from the term it qualifies.
`static String`	`stringToKIF(String input, boolean upcaseFirst)` Convert any arbitrary string to a valid KIF id.
`static String`	`StringToKIFid(String s)` Convert an arbitrary string to a legal KIF identifier by substituting dashes for illegal characters.
`static String`	`StringToPrologID(String s)` Convert an arbitrary string to a legal Prolog identifier by substituting dashes for illegal characters.
`static String`	`toBase64(String input, String charset)` Given an input String encoded in charset, returns a String representing the base-64 encoding of the input.
`static String`	`toSafeNamespaceDelimiter(String term)` Replaces the namespace delimiter in term with a string that is safe for inference, and for all common file systems.
`static String`	`toSafeNamespaceDelimiter(String kbHref, String term)` Replaces the namespace delimiter in term with a string that is safe for inference and for all common file systems, but only if kbHref is an empty string or == null.
`static String`	`treeReplace(String oldPattern, String newTerm, String tree)` Performs a depth-first search of tree, replacing all terms matching oldPattern with newTerm.
`static String`	`unquote(String input)`
`static String`	`w3cToKif(String term)`
`static String`	`wordWrap(String input)` Convenience method with default line length of 70
`static String`	`wordWrap(String input, int length)`

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

- Method Detail
  - setCharset
```
public static void setCharset(String charEncoding)
```
    Sets the default value of CHARSET to charEncoding. charEncoding should be a String denoting a valid W3C character encoding scheme, such as "UTF-8".
    
    Parameters:
    
    charEncoding - A String denoting a character encoding scheme
  - getCharset
```
public static String getCharset()
```
    Returns a String denoting a character encoding scheme. The default value is "UTF-8".
    
    Returns:
    
    String
  - encode
```
public static String encode(String input)
```
    Returns a URL encoded String obtained from input, which is assumed to be a String composed of characters in the default charset. In most cases, the charset will be UTF-8.
    
    Parameters:
    
    input - A String which has not yet been URL encoded
    
    Returns:
    
    A URL encoded String
  - decode
```
public static String decode(String input)
```
    Returns a URL decoded String obtained from input, which is assumed to be a URL encoded String composed of characters in the default charset. In most cases, the charset will be UTF-8.
    
    Parameters:
    
    input - A URL encoded String
    
    Returns:
    
    A String that has been URL decoded
  - getLineSeparator
```
public static String getLineSeparator()
```
    Returns the default line separator token for the current runtime platform.
    
    Returns:
    
    String
  - setLineSeparator
```
public static void setLineSeparator(String separator)
```
    Sets the default line separator token for the current runtime platform.
    
    Parameters:
    
    separator - The String to use as the line separator
  - getKifNamespaceDelimiter
```
public static String getKifNamespaceDelimiter()
```
    Returns the string used in SUO-KIF to separate a namespace prefix from the term it qualifies.
  - setKifNamespaceDelimiter
```
public static String setKifNamespaceDelimiter(String str)
```
    Sets to str the String used in SUO-KIF to separate a namespace prefix from the term it qualifies.
  - getW3cNamespaceDelimiter
```
public static String getW3cNamespaceDelimiter()
```
    Returns the string preferred by W3C to separate a namespace prefix from the term it qualifies.
  - setW3cNamespaceDelimiter
```
public static String setW3cNamespaceDelimiter(String str)
```
    Sets to str the String token preferred by W3C to separate a namespace prefix from the term it qualifies.
  - getSafeNamespaceDelimiter
```
public static String getSafeNamespaceDelimiter()
```
    Returns a "safe" alphanumeric ASCII string that can be substituted for the W3C or SUO-KIF string delimiting a namespace prefix from an unqualified term name. The safe delimiter is used to produce input formulae or files that can be loaded by Vampire and other provers unable to handle term names containing non-alphanumeric characters.
  - setSafeNamespaceDelimiter
```
public static String setSafeNamespaceDelimiter(String str)
```
    Sets to str the "safe" alphanumeric ASCII String value that can be substituted for the W3C or SUO-KIF string delimiting a namespace prefix from an unqualified term name. The safe delimiter is used to produce input formulae or files that can be loaded by Vampire and other provers unable to handle term names containing non-alphanumeric characters.
  - toBase64
```
public static String toBase64(String input,
                              String charset)
```
    Given an input String encoded in charset, returns a String representing the base-64 encoding of the input.
    
    Parameters:
    
    input - A String
    
    charset - A String constant denoting a Charset
    
    Returns:
    
    a base-64 String
  - fromBase64
```
public static String fromBase64(String input,
                                String charset)
```
    Given an input String encoded in base-64, decodes the String and returns the original form of input in charset.
    
    Parameters:
    
    input - A base-64 String
    
    charset - A String constant denoting a Charset, such at UTF-8
    
    Returns:
    
    a String decoded from base-64 to its original form in charset
  - encrypt
```
public static String encrypt(String input,
                             String charset)
```
    Converts input, which is assumed to belong to charset, to a base 64 representation, and then encrypts the result using the SHA algorithm.
    
    Parameters:
    
    input - A String in charset
    
    charset - A String constant denoting a Charset, such at UTF-8
    
    Returns:
    
    a String that has been converted to base 64 encoding and then encrypted via SHA
  - isNonEmptyString
```
public static boolean isNonEmptyString(Object obj)
```
    Parameters:
    
    obj - Any object
    
    Returns:
    
    true if obj is a non-empty String, else false.
  - emptyString
```
public static boolean emptyString(Object s)
```
    Parameters:
    
    s - An input Object, expected to be a String.
    
    Returns:
    
    true if s == null or s is an empty String, else false.
  - removeEnclosingQuotes
```
public static String removeEnclosingQuotes(String s)
```
    Removes all balanced ASCII double-quote characters from each end of the String s, if any are present.
  - removeEnclosingChar
```
public static String removeEnclosingChar(String s,
                                         int n,
                                         char c)
```
    Removes n layers of balanced ASCII double-quote characters from each end of the String s, if any are present.
  - removeEnclosingChars
```
public static String removeEnclosingChars(String s,
                                          int n,
                                          char c)
```
    Removes n layers of balanced characters from each end of the String s, if any are present.
  - removeEnclosingCharPair
```
public static String removeEnclosingCharPair(String s,
                                             int n,
                                             char c1,
                                             char c2)
```
    Removes n layers of balanced characters from each end of the String s, if any are present.
  - removePunctuation
```
public static String removePunctuation(String sentence)
```
    Remove punctuation and contractions from a sentence.
  - removeHTML
```
public static String removeHTML(String sentence)
```
    Remove HTML markup from a sentence.
  - normalizeSpaceChars
```
public static String normalizeSpaceChars(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with space characters normalized to match the conventions for written English text. All linefeeds and carriage returns are replaced with spaces.
  - arrayListToSpacedString
```
public static String arrayListToSpacedString(ArrayList<String> al)
```
    Convert an arbitrary string to a legal KIF identifier by substituting dashes for illegal characters. TODO: isJavaIdentifierPart() isn't sufficient, since it allows characters KIF doesn't
  - StringToKIFid
```
public static String StringToKIFid(String s)
```
    Convert an arbitrary string to a legal KIF identifier by substituting dashes for illegal characters. TODO: isJavaIdentifierPart() isn't sufficient, since it allows characters KIF doesn't
  - StringToPrologID
```
public static String StringToPrologID(String s)
```
    Convert an arbitrary string to a legal Prolog identifier by substituting dashes for illegal characters.
  - escapeQuoteChars
```
public static String escapeQuoteChars(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all double quote characters properly escaped with a left slash character.
  - escapeEscapeChars
```
public static String escapeEscapeChars(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all escape characters properly escaped with a left slash character.
  - removeQuoteEscapes
```
public static String removeQuoteEscapes(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all left slash characters removed
  - removeEscapedEscapes
```
public static String removeEscapedEscapes(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String in which each sequence of two or more slash-escape chars is replaced by one slash-escape char.
  - removeEscapedDoubleQuotes
```
public static String removeEscapedDoubleQuotes(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all internal escaped double quote characters removed
  - removeInternalDoubleQuotes
```
public static String removeInternalDoubleQuotes(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all internal double quote characters removed
  - replaceRepeatedDoubleQuotes
```
public static String replaceRepeatedDoubleQuotes(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all sequences of two double quote characters have been replaced by a left slash character followed by a double quote character.
  - allCapsToSUMOID
```
public static String allCapsToSUMOID(String str)
```
  - asSUMORelationID
```
public static String asSUMORelationID(String str)
```
  - containsNonAsciiChars
```
public static boolean containsNonAsciiChars(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    true if str contains any non-ASCII characters, else false.
  - replaceNonAsciiChars
```
public static String replaceNonAsciiChars(String str)
```
    Parameters:
    
    str - A String
    
    Returns:
    
    A String with all non-ASCII characters replaced by "x".
  - replaceNonIdChars
```
public static String replaceNonIdChars(String st)
```
    Replace any character that isn't a valid KIF identifier character with a lower-case x.
  - getDateTime
```
public static String getDateTime(String pattern)
```
    Returns a date/time string corresponding to pattern. The date/time returned is the date/time of the method call. The locale is UTC (Greenwich).
    
    Parameters:
    
    pattern - Examples: yyyy, yyyy-MM-dd.
  - replaceDateTime
```
public static String replaceDateTime(String input)
```
    If the input String contains the sequence {date}pattern{date}, replaces the first occurrence of this sequence with a UTC date/time string formatted according to pattern. If the input String does not contain the sequence, it is returned unaltered.
    
    Parameters:
    
    input - The input String into which a formatted date/time will be inserted
    
    Returns:
    
    String
  - isUri
```
public static boolean isUri(String input)
```
    Returns true if input appears to be a URI string, else returns false.
    
    Parameters:
    
    input - A String
  - isStringWithSpaces
```
public static boolean isStringWithSpaces(String input)
```
    Returns true if input is a String containing some whitespace chars, else returns false.
    
    Parameters:
    
    input - A String
    
    Returns:
    
    true or false
  - isQuotedString
```
public static boolean isQuotedString(String input)
```
    Returns true if input appears to be a quoted String, else returns false.
    
    Parameters:
    
    input - A String
  - makeQuotedString
```
public static String makeQuotedString(String input,
                                      char quoteChar)
```
    Returns a new String formed by adding quoteChar to each end of input.
    
    Parameters:
    
    input - A String
  - isDigitString
```
public static boolean isDigitString(String input)
```
    Returns true if every char in input is a digit char, else returns false.
    
    Parameters:
    
    input - A String
    
    Returns:
    
    true or false
  - isNumeric
```
public static boolean isNumeric(String input)
```
  - concatN
```
public static String concatN(String input,
                             int n)
```
    Returns a String formed from n concatenations of input.
    
    Parameters:
    
    input - A String
    
    n - A non-negative int
    
    Returns:
    
    true or false
  - treeReplace
```
public static String treeReplace(String oldPattern,
                                 String newTerm,
                                 String tree)
```
    Performs a depth-first search of tree, replacing all terms matching oldPattern with newTerm.
    
    Parameters:
    
    oldPattern - A regular expression pattern to be matched against terms in tree
    
    newTerm - A String to replace terms matching oldPattern
    
    tree - A String representing a SUO-KIF Formula (list)
    
    Returns:
    
    A new tree (String), with all occurrences of terms matching oldPattern replaced by newTerm
  - kifListToArrayList
```
public static ArrayList kifListToArrayList(String kifListAsString)
```
    Returns a new ArrayList formed by extracting in order the top-level members of kifListAsString, which is assumed to be the String representation of a SUO-KIF (LISP) list.
    
    Parameters:
    
    kifListAsString - A SUO-KIF list represented as a String
    
    Returns:
    
    ArrayList
  - replaceUnsafeNamespaceDelimiters
```
public static String replaceUnsafeNamespaceDelimiters(String input)
```
    Replaces non-alphanumeric namespace delimiters in input with an alphanumeric form that can be handled by Vampire and other provers.
    
    Parameters:
    
    input - The String representation of a SUO-KIF Formula or other expression
    
    Returns:
    
    String The input string with unsafe namespace delimiters replaced by a safe alphanumeric form
  - safeToKifNamespaceDelimiters
```
public static String safeToKifNamespaceDelimiters(String input)
```
    Replaces all occurrences of the "safe" namespace delimiter in input with the default KIF namespace delimiter, which might contain characters that are not acceptable to some provers.
    
    Parameters:
    
    input - The String representation of a SUO-KIF Formula or other expression, such as a TPTP Formula
    
    Returns:
    
    String The input string with occurrences of the safe namespace delimiters replaced by the default KIF namespace delimiter
  - toSafeNamespaceDelimiter
```
public static String toSafeNamespaceDelimiter(String term)
```
    Replaces the namespace delimiter in term with a string that is safe for inference, and for all common file systems.
  - toSafeNamespaceDelimiter
```
public static String toSafeNamespaceDelimiter(String kbHref,
                                              String term)
```
    Replaces the namespace delimiter in term with a string that is safe for inference and for all common file systems, but only if kbHref is an empty string or == null. If kbHref is not empty, term is probably being prepared for display in the Sigma Browser and does not have to be converted to a "safe" form.
  - w3cToKif
```
public static String w3cToKif(String term)
```
  - kifToW3c
```
public static String kifToW3c(String term)
```
  - quote
```
public static String quote(String input)
```
  - unquote
```
public static String unquote(String input)
```
  - isLocalTermReference
```
public static boolean isLocalTermReference(String term)
```
  - getLocalReferenceBaseName
```
public static String getLocalReferenceBaseName()
```
  - setLocalReferenceBaseName
```
public static void setLocalReferenceBaseName(String basename)
```
  - renameFileIfExists
```
public static File renameFileIfExists(File f)
```
    If the file f already exists, this method returns a new File object with a unique name formed by appending an integer. If the filename has a file type suffix, the integer is inserted between the base name and the suffix. If f does not exist, it is simply returned.
    
    Parameters:
    
    f - A File
    
    Returns:
    
    A File with a name different from f's name, if f exists, else f.
  - wordWrap
```
public static String wordWrap(String input,
                              int length)
```
  - wordWrap
```
public static String wordWrap(String input)
```
    Convenience method with default line length of 70
  - stringToKIF
```
public static String stringToKIF(String input,
                                 boolean upcaseFirst)
```
    Convert any arbitrary string to a valid KIF id. There is no guarantee that it is unique however, since the current KB isn't inspected.
  - indent
```
public static String indent(int num,
                            String indentChars)
```
  - findBalancedParen
```
public static int findBalancedParen(int pIndex,
                                    String st)
```
    Find the parenthesis that balances the one in st at character pIndex
    
    Returns:
    
    -1 if not found
  - fillString
```
public static String fillString(String st,
                                char fillchar,
                                int totalLength,
                                boolean prepend)
```
    Fill a string with the desired character up to the totalLength. If string is null return a completely filled string.
  - main
```
public static void main(String[] args)
```
  - getContents
```
public static String getContents(File aFile)
```
    Fetch the entire contents of a text file, and return it in a String. This style of implementation does not throw Exceptions to the caller.
    
    Parameters:
    
    aFile - is a file which already exists and can be read.
  - filterHtml
```
public static String filterHtml(String input)
```
    Remove HTML from input string.
    
    Parameters:
    
    input -
    
    Returns:

Class StringUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setCharset

getCharset

encode

decode

getLineSeparator

setLineSeparator

getKifNamespaceDelimiter

setKifNamespaceDelimiter

getW3cNamespaceDelimiter

setW3cNamespaceDelimiter

getSafeNamespaceDelimiter

setSafeNamespaceDelimiter

toBase64

fromBase64

encrypt

isNonEmptyString

emptyString

removeEnclosingQuotes

removeEnclosingChar

removeEnclosingChars

removeEnclosingCharPair

removePunctuation

removeHTML

normalizeSpaceChars

arrayListToSpacedString

StringToKIFid

StringToPrologID

escapeQuoteChars

escapeEscapeChars

removeQuoteEscapes

removeEscapedEscapes

removeEscapedDoubleQuotes

removeInternalDoubleQuotes

replaceRepeatedDoubleQuotes

allCapsToSUMOID

asSUMORelationID

containsNonAsciiChars

replaceNonAsciiChars

replaceNonIdChars

getDateTime

replaceDateTime

isUri

isStringWithSpaces

isQuotedString

makeQuotedString

isDigitString

isNumeric

concatN

treeReplace

kifListToArrayList

replaceUnsafeNamespaceDelimiters

safeToKifNamespaceDelimiters

toSafeNamespaceDelimiter

toSafeNamespaceDelimiter

w3cToKif

kifToW3c

quote

unquote

isLocalTermReference

getLocalReferenceBaseName

setLocalReferenceBaseName

renameFileIfExists

wordWrap

wordWrap

stringToKIF

indent

findBalancedParen

fillString

main

getContents

filterHtml