MaryUtils (MaryTTS 5.2 API)

java.lang.Object
- marytts.util.MaryUtils

```
public class MaryUtils
extends Object
```
A collection of useful static little utility methods.

Author:

Marc Schröder

Field Summary

Fields
Modifier and Type	Field and Description
`protected static char[]`	`germanToAsciiLetterTable`
`static String`	`LOGPREFIX`
`protected static char[]`	`punctuationTable`
`protected static char[]`	`toGermanLetterTable`
`protected static char[]`	`toItalianLetterTable`

Constructor Summary

Constructors
Constructor and Description

MaryUtils()

Constructors
Constructor and Description
`MaryUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Map<String,String>`	`arrayToMap(String[] a)` Create a map from an Object array which contains paired entries (key, value, key, value, ....).
`static long`	`availableMemory()` Determine the amount of available memory.
`static File`	`createSelfDeletingTempFile(int lifetimeInSeconds)` Create a temporary file that will be deleted after a specified number of seconds.
`static String`	`getExtension(File f)` Get the extension of a file.
`static String`	`getFirstMeaningfulMessage(Throwable t)` From the given throwable or its cause, or cause's cause, etc., get the first one that has a non-empty message, and return that message.
`static org.apache.log4j.Logger`	`getLogger(Class clazz)` Provide a Logger object whose name is built from MaryUtils.LOGPREFIX and the given nameSuffix.
`static org.apache.log4j.Logger`	`getLogger(String nameSuffix)` Provide a Logger object whose name is built from MaryUtils.LOGPREFIX and the given nameSuffix.
`static int`	`getNumber(String string)` For a string containing a number as judged by `isNumber()`, return the numerical value, rounded to an integer.
`static int`	`getNumberDelta(String string)` For a string containing a number delta as judged by `isNumberDelta()`, return the numerical value, rounded to an integer.
`static int`	`getPercentageDelta(String string)` For a string containing a percentage delta as judged by `isPercentageDelta()`, return the numerical value, rounded to an integer.
`static double`	`getSemitonesDelta(String string)` For a string containing a semitones delta as judged by `isSemitonesDelta()`, return the numerical value, as a double.
`static String`	`getThrowableAndCausesAsString(Throwable t)` Apply the toString() method recursively to this throwable and all its causes.
`static int`	`getUnsignedNumber(String string)` For a string containing an unsigned number as judged by `isUnsignedNumber()`, return the numerical value, rounded to an integer.
`static double`	`getUnsignedSemitones(String string)` For a string containing an unsigned semitones expression as judged by `isUnsignedSemitones()`, return the numerical value as a double.
`static int`	`indexOf(byte[] bytes, byte[] pattern)` Check if bytes contains a subsequence identical with pattern, and return the index position.
`static boolean`	`isLittleEndian()`
`static boolean`	`isLog4jConfigured()` Returns true if it appears that log4j have been previously configured.
`static boolean`	`isNumber(String string)` Tell whether the string contains a number.
`static boolean`	`isNumberDelta(String string)` Tell whether the string contains a positive or negative number delta, i.e., a number with an obligatory + or - sign.
`static boolean`	`isPercentageDelta(String string)` Tell whether the string contains a positive or negative percentage delta, i.e., a percentage number with an obligatory + or - sign.
`static boolean`	`isSemitonesDelta(String string)` Tell whether the string contains a positive or negative semitones delta, i.e., a semitones number with an obligatory + or - sign, such as "+3.2st" or "-13.2st".
`static boolean`	`isUnsignedNumber(String string)` Tell whether the string contains an unsigned number.
`static boolean`	`isUnsignedSemitones(String string)` Tell whether the string contains an unsigned semitones expression, such as "12st" or "5.4st".
`static boolean`	`isWindows()`
`static String`	`joinStrings(Collection<String> strings)` Join a collection of strings into a single String object, in the order indicated by the collection's iterator.
`static String`	`locale2xmllang(Locale locale)` Convert a locale into a string that is conform with XML's xml:lang attribute.
`static String`	`normaliseUnicodeLetters(String unicodeText, Locale targetLocale)` Normalise the Unicode text by mapping "exotic" letter characters to "standard" ones.
`static String`	`normaliseUnicodePunctuation(String unicodeText)` Normalise the Unicode text by mapping "exotic" punctuation characters to "standard" ones.
`static int`	`romanToInt(String romanNumber)`
`static int`	`shellExecute(String strCommand)`
`static int`	`shellExecute(String strCommand, boolean bDisplayProgramOutput)`
`static String[]`	`splitIntoSensibleXMLUnits(String s)`
`static Locale`	`string2locale(String localeString)`
`static Character[]`	`StringToCharacterArray(String s)`
`static boolean`	`subsumes(Locale general, Locale specific)` Test for lax Locale equality.
`static String`	`toHumanReadableSize(long byteCount)`
`static void`	`writeCopyrightNotice(PrintWriter out, String commentChar)`

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

- Field Detail
  - LOGPREFIX
```
public static final String LOGPREFIX
```
    See Also:
    Constant Field Values
  - punctuationTable
```
protected static final char[] punctuationTable
```
  - toGermanLetterTable
```
protected static final char[] toGermanLetterTable
```
  - toItalianLetterTable
```
protected static final char[] toItalianLetterTable
```
  - germanToAsciiLetterTable
```
protected static final char[] germanToAsciiLetterTable
```
- Constructor Detail
  - MaryUtils
```
public MaryUtils()
```
- Method Detail
  - arrayToMap
```
public static Map<String,String> arrayToMap(String[] a)
```
    Create a map from an Object array which contains paired entries (key, value, key, value, ....).
    
    Parameters:
    a - a
    
    Returns:
    m
  - StringToCharacterArray
```
public static Character[] StringToCharacterArray(String s)
```
  - joinStrings
```
public static String joinStrings(Collection<String> strings)
```
    Join a collection of strings into a single String object, in the order indicated by the collection's iterator.
    
    Parameters:
    strings - a collection containing exclusively String objects
    
    Returns:
    a single String object
  - indexOf
```
public static int indexOf(byte[] bytes,
          byte[] pattern)
```
    Check if bytes contains a subsequence identical with pattern, and return the index position. Assumes that pattern.length ^< bytes.length.
    
    Parameters:
    bytes - bytes
    pattern - pattern
    
    Returns:
    the index position in bytes where pattern starts, or -1 if bytes does not contain pattern.
  - splitIntoSensibleXMLUnits
```
public static String[] splitIntoSensibleXMLUnits(String s)
```
  - getExtension
```
public static String getExtension(File f)
```
    Get the extension of a file.
    
    Parameters:
    f - f
    
    Returns:
    ext
  - romanToInt
```
public static int romanToInt(String romanNumber)
```
  - isPercentageDelta
```
public static boolean isPercentageDelta(String string)
```
    Tell whether the string contains a positive or negative percentage delta, i.e., a percentage number with an obligatory + or - sign.
    
    Parameters:
    string - string
    
    Returns:
    s.substring
  - getPercentageDelta
```
public static int getPercentageDelta(String string)
```
    For a string containing a percentage delta as judged by isPercentageDelta(), return the numerical value, rounded to an integer.
    
    Parameters:
    string - string
    
    Returns:
    the numeric part of the percentage, rounded to an integer, or 0 if the string is not a valid percentage delta.
  - isSemitonesDelta
```
public static boolean isSemitonesDelta(String string)
```
    Tell whether the string contains a positive or negative semitones delta, i.e., a semitones number with an obligatory + or - sign, such as "+3.2st" or "-13.2st".
    
    Parameters:
    string - string
    
    Returns:
    s.substring(s.length() - 2).equals("st") and isNumberDelta(s.substring(0, s.length() - 2))
  - getSemitonesDelta
```
public static double getSemitonesDelta(String string)
```
    For a string containing a semitones delta as judged by isSemitonesDelta(), return the numerical value, as a double.
    
    Parameters:
    string - string
    
    Returns:
    the numeric part of the semitones delta, or 0 if the string is not a valid semitones delta.
  - isNumberDelta
```
public static boolean isNumberDelta(String string)
```
    Tell whether the string contains a positive or negative number delta, i.e., a number with an obligatory + or - sign.
    
    Parameters:
    string - string
    
    Returns:
    (s.charAt(0) == '+' or s.charAt(0) == '-') and isUnsignedNumber(s.substring(1))
  - getNumberDelta
```
public static int getNumberDelta(String string)
```
    For a string containing a number delta as judged by isNumberDelta(), return the numerical value, rounded to an integer.
    
    Parameters:
    string - string
    
    Returns:
    the numeric value, rounded to an integer, or 0 if the string is not a valid number delta.
  - isUnsignedSemitones
```
public static boolean isUnsignedSemitones(String string)
```
    Tell whether the string contains an unsigned semitones expression, such as "12st" or "5.4st".
    
    Parameters:
    string - string
    
    Returns:
    s.substring(s.length() - 2).equals("st") and isUnsignedNumber(s.substring(0, s.length() - 2))
  - getUnsignedSemitones
```
public static double getUnsignedSemitones(String string)
```
    For a string containing an unsigned semitones expression as judged by isUnsignedSemitones(), return the numerical value as a double.
    
    Parameters:
    string - string
    
    Returns:
    the numeric part of the semitones expression, or 0 if the string is not a valid unsigned semitones expression.
  - isUnsignedNumber
```
public static boolean isUnsignedNumber(String string)
```
    Tell whether the string contains an unsigned number.
    
    Parameters:
    string - string
    
    Returns:
    false if s.length <1, true otherwise
  - getUnsignedNumber
```
public static int getUnsignedNumber(String string)
```
    For a string containing an unsigned number as judged by isUnsignedNumber(), return the numerical value, rounded to an integer.
    
    Parameters:
    string - string
    
    Returns:
    the numeric value, rounded to an integer, or 0 if the string is not a valid unsigned number.
  - isNumber
```
public static boolean isNumber(String string)
```
    Tell whether the string contains a number.
    
    Parameters:
    string - string
    
    Returns:
    false if s.length <1, true otherwise
  - getNumber
```
public static int getNumber(String string)
```
    For a string containing a number as judged by isNumber(), return the numerical value, rounded to an integer.
    
    Parameters:
    string - string
    
    Returns:
    the numeric value, rounded to an integer, or 0 if the string is not a valid number.
  - string2locale
```
public static Locale string2locale(String localeString)
```
  - locale2xmllang
```
public static String locale2xmllang(Locale locale)
```
    Convert a locale into a string that is conform with XML's xml:lang attribute. Basically it is language-COUNTRY, e.g. en-US.
    
    Parameters:
    locale - a locale, must not be null
    
    Returns:
    language of locale
    
    Throws:
    
    IllegalArgumentException - if locale is null
  - subsumes
```
public static boolean subsumes(Locale general,
               Locale specific)
```
    Test for lax Locale equality. More precisely, returns true if (a) both are equal; (b) general only specifies language, and specific has the same language; (c) general specifies language and country, and specific has the same language and country. Else returns false.
    
    Parameters:
    general - general
    specific - specific
    
    Returns:
    false if general is null or specific is null, true otherwise
  - availableMemory
```
public static long availableMemory()
```
    Determine the amount of available memory. "Available" memory is calculated as (max - total) + free.
    
    Returns:
    the number of bytes of memory available according to the above algorithm.
  - createSelfDeletingTempFile
```
public static File createSelfDeletingTempFile(int lifetimeInSeconds)
                                       throws IOException
```
    Create a temporary file that will be deleted after a specified number of seconds. The file will be deleted regardless of whether it is still used or not, so be sure to specify a sufficiently large value.
    
    Parameters:
    lifetimeInSeconds - the number of seconds after which the file will be deleted -- e.g., 3600 means that the file will be deleted one hour after creation.
    
    Returns:
    the File that was created.
    
    Throws:
    
    IOException - IOException
  - normaliseUnicodePunctuation
```
public static String normaliseUnicodePunctuation(String unicodeText)
```
    Normalise the Unicode text by mapping "exotic" punctuation characters to "standard" ones.
    
    Parameters:
    unicodeText - a string that may include "exotic" punctuation characters
    
    Returns:
    the string in which exotic characters have been replaced with their closest relative that can be handled by the TTS.
  - normaliseUnicodeLetters
```
public static String normaliseUnicodeLetters(String unicodeText,
                             Locale targetLocale)
```
    Normalise the Unicode text by mapping "exotic" letter characters to "standard" ones. Standard is locale-dependent. For GERMAN: ascii plus german umlauts and ß. For other locales: ascii.
    
    Parameters:
    unicodeText - a string that may include "exotic" letter characters
    targetLocale - the locale against which normalisation is to be performed.
    
    Returns:
    the string in which exotic characters have been replaced with their closest relative that can be handled by the TTS.
  - getThrowableAndCausesAsString
```
public static String getThrowableAndCausesAsString(Throwable t)
```
    Apply the toString() method recursively to this throwable and all its causes. The idea is to get cause information as in printStackTrace() without the stack trace.
    
    Parameters:
    t - the throwable to print.
    
    Returns:
    buf converted to string
  - isWindows
```
public static boolean isWindows()
```
  - isLittleEndian
```
public static boolean isLittleEndian()
```
  - shellExecute
```
public static int shellExecute(String strCommand)
```
  - shellExecute
```
public static int shellExecute(String strCommand,
               boolean bDisplayProgramOutput)
```
  - writeCopyrightNotice
```
public static void writeCopyrightNotice(PrintWriter out,
                        String commentChar)
```
  - toHumanReadableSize
```
public static String toHumanReadableSize(long byteCount)
```
  - getLogger
```
public static org.apache.log4j.Logger getLogger(String nameSuffix)
```
    Provide a Logger object whose name is built from MaryUtils.LOGPREFIX and the given nameSuffix.
    
    Parameters:
    nameSuffix - the suffix to use for the logger name.
    
    Returns:
    Logger.getLogger(LOGPREFIX + "." + nameSuffix)
  - getLogger
```
public static org.apache.log4j.Logger getLogger(Class clazz)
```
    Provide a Logger object whose name is built from MaryUtils.LOGPREFIX and the given nameSuffix.
    
    Parameters:
    clazz - the class to use for the logger name.
    
    Returns:
    getLogger(clazz.getSimpleName())
  - isLog4jConfigured
```
public static boolean isLog4jConfigured()
```
    Returns true if it appears that log4j have been previously configured. This code checks to see if there are any appenders defined for log4j which is the definitive way to tell if log4j is already initialized
    
    Returns:
    true if appenders.hasMoreElements, false otherwise
  - getFirstMeaningfulMessage
```
public static String getFirstMeaningfulMessage(Throwable t)
```
    From the given throwable or its cause, or cause's cause, etc., get the first one that has a non-empty message, and return that message.
    
    Parameters:
    t - t
    
    Returns:
    the first non-empty message string, or null.

Class MaryUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGPREFIX

punctuationTable

toGermanLetterTable

toItalianLetterTable

germanToAsciiLetterTable

Constructor Detail

MaryUtils

Method Detail

arrayToMap

StringToCharacterArray

joinStrings

indexOf

splitIntoSensibleXMLUnits

getExtension

romanToInt

isPercentageDelta

getPercentageDelta

isSemitonesDelta

getSemitonesDelta

isNumberDelta

getNumberDelta

isUnsignedSemitones

getUnsignedSemitones

isUnsignedNumber

getUnsignedNumber

isNumber

getNumber

string2locale

locale2xmllang

subsumes

availableMemory

createSelfDeletingTempFile

normaliseUnicodePunctuation

normaliseUnicodeLetters

getThrowableAndCausesAsString

isWindows

isLittleEndian

shellExecute

shellExecute

writeCopyrightNotice

toHumanReadableSize

getLogger

getLogger

isLog4jConfigured

getFirstMeaningfulMessage