org.midica.midi

Class LyricUtil

java.lang.Object

org.midica.midi.LyricUtil

public final class LyricUtil
extends java.lang.Object

This class provides methods to deal with Lyrics events, especially according to RP-026.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ArrayList<java.util.regex.Pattern>	escapePatterns
private static java.util.ArrayList<java.lang.String>	escapeReplacements
private static java.util.ArrayList<java.util.regex.Pattern>	forwardPatterns
private static java.util.ArrayList<java.lang.String>	forwardReplacements
private static LyricUtil	instance Singleton object of this class
private static java.util.regex.Pattern	pattCR
private static java.util.regex.Pattern	pattLF
private static java.util.regex.Pattern	pattSongInfo
private static java.util.regex.Pattern	pattTab
private static java.util.ArrayList<java.util.regex.Pattern>	reversePatterns
private static java.util.ArrayList<java.lang.String>	reverseReplacements
private static java.util.ArrayList<java.lang.String>	reverseSpecialChars
static java.lang.String	SOFTWARE used for the software and version meta info
private static java.util.regex.Pattern	tagPattern

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LyricUtil() Private constructor, precompiling needed regex patterns.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	decodeHashes(java.lang.String text) Replaces hash values by their original escaped characters.
private java.lang.String	encodeHashes(java.lang.String text) Replaces escaped characters with their hash values so that they don’t disturb regexes.
java.lang.String	escape(java.lang.String text) Escapes special characters of the given string according to RP-026.
static LyricUtil	getInstance() Creates and returns a singleton object of this class.
java.util.HashMap<java.lang.String,java.lang.String>	getSongInfo(java.lang.String text) Searches for song info tags in the given text.
private java.lang.String	hashesToSpecial(java.lang.String text) Replaces hash values of escaped characters by the according special characters.
java.lang.String	removeTags(java.lang.String text) Removes RP-026 tags from the given lyrics text.
java.lang.String	unescapeSpecialWhitespaces(java.lang.String text) Unescapes escaped special whitespace characters in lyrics events.

Methods inherited from class java.lang.Object

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

Field Detail

SOFTWARE

public static final java.lang.String SOFTWARE

used for the software and version meta info

See Also:

Constant Field Values

instance

private static LyricUtil instance

Singleton object of this class

forwardPatterns

private static final java.util.ArrayList<java.util.regex.Pattern> forwardPatterns

forwardReplacements

private static final java.util.ArrayList<java.lang.String> forwardReplacements

reversePatterns

private static final java.util.ArrayList<java.util.regex.Pattern> reversePatterns

reverseReplacements

private static final java.util.ArrayList<java.lang.String> reverseReplacements

reverseSpecialChars

private static final java.util.ArrayList<java.lang.String> reverseSpecialChars

tagPattern

private static final java.util.regex.Pattern tagPattern

pattSongInfo

private static final java.util.regex.Pattern pattSongInfo

escapePatterns

private static final java.util.ArrayList<java.util.regex.Pattern> escapePatterns

escapeReplacements

private static final java.util.ArrayList<java.lang.String> escapeReplacements

pattCR

private static final java.util.regex.Pattern pattCR

pattLF

private static final java.util.regex.Pattern pattLF

pattTab

private static final java.util.regex.Pattern pattTab

Constructor Detail

LyricUtil

private LyricUtil()

Private constructor, precompiling needed regex patterns.

Method Detail

getInstance

public static final LyricUtil getInstance()

Creates and returns a singleton object of this class.

Returns:

a singleton object of this class.

getSongInfo

public final java.util.HashMap<java.lang.String,java.lang.String> getSongInfo(java.lang.String text)

Searches for song info tags in the given text. The text is assumed to be the text part of a lyrics meta event. Such tags look like {#…=…}.

Parameters:

text - The text to search.

Returns:

a list of found info keys and their according values.

escape

public final java.lang.String escape(java.lang.String text)

Escapes special characters of the given string according to RP-026.

Parameters:

text - The text to be escaped.

Returns:

the escaped text.

unescapeSpecialWhitespaces

public final java.lang.String unescapeSpecialWhitespaces(java.lang.String text)

Unescapes escaped special whitespace characters in lyrics events. Replaces \r, \n and \t.

Parameters:

text - The text to unescape.

Returns:

the unescaped text.

removeTags

public final java.lang.String removeTags(java.lang.String text)

Removes RP-026 tags from the given lyrics text.

Parameters:

text - The lyrics text.

Returns:

the cleaned text.

encodeHashes

private final java.lang.String encodeHashes(java.lang.String text)

Replaces escaped characters with their hash values so that they don’t disturb regexes.

Parameters:

text - The text to be encoded.

Returns:

the encoded text.

decodeHashes

private final java.lang.String decodeHashes(java.lang.String text)

Replaces hash values by their original escaped characters.

Parameters:

text - The text to be decoded.

Returns:

the decoded text.

hashesToSpecial

private final java.lang.String hashesToSpecial(java.lang.String text)

Replaces hash values of escaped characters by the according special characters.

Parameters:

text - The text to be decoded.

Returns:

the decoded text.