jhelp.util.text

Class UtilText

java.lang.Object

jhelp.util.text.UtilText

public final class UtilText
extends java.lang.Object

Textual utilities

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ESCAPE_CHARACTERS Default escape characters : \ (see StringExtractor)
static java.lang.String	DEFAULT_SEPARATORS Default escape separators : [space], [Line return \n], [tabulation \t], [carriage return \r] and [\f] (see StringExtractor)
static java.lang.String	DEFAULT_STRING_LIMITERS Default string limiters : " and ' (see StringExtractor)
static java.nio.charset.Charset	UTF8 UTF-8 char set

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UtilText() To avoid instance

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	addAntiSlash(java.lang.String string, boolean simpleQuote) Add \ before each " we can chose do treat the ' as normal character or add \ before it also
private static void	appendObject(java.lang.StringBuffer stringBuffer, java.lang.Object object) Append an object to string buffer
static java.lang.String[]	capture(java.lang.String pattern, java.lang.String text)
static java.lang.String	colorText(int color) Color to text representation
static int	computeDistance(java.lang.String text1, java.lang.String text2, boolean caseSensitive, java.lang.String wordDelimiters) Compute "distance" between two texts.
static java.lang.String	computeNotInsideName(java.lang.String base, java.util.Collection<java.lang.String> names) Compute a name not inside a set of name
static java.lang.String	computeOtherName(java.lang.String name) Compute an other name for a String name.
static java.lang.String	concatenate(java.lang.Object... objects) Concatenate several object to make a string representation
static java.lang.String[]	cutSringInPart(java.lang.String string, char separator) Cut String in several parts
static int	indexOf(java.lang.CharSequence charSequence, char... characters) Compute the first index in the char sequence of one of given characters
static int	indexOf(java.lang.CharSequence charSequence, int offset, char... characters) Compute the first index >= at the given offset in the char sequence of one of given characters
static int	indexOf(java.lang.String[] tableau, java.lang.String chaine) Index of a string in string array
static int	indexOfIgnoreString(java.lang.String string, char character) Compute the index of a character in a string on ignoring characters between " or ' an in ignore characters with \ just before them
static int	indexOfIgnoreStrings(java.lang.String text, java.lang.String search, int startIndex, java.lang.String stringLimiters) Give index of a string inside an other one on ignoring characters bettwen string delimiters.
static java.lang.String	interpretAntiSlash(java.lang.String string) Replace character that follow an \ by it's symbol : \n by carriage return, \t by tabulation and \<other> by <other>
static int	lastIndexOf(java.lang.CharSequence charSequence, char... characters) Compute the last index in the char sequence of one of given characters
static int	lastIndexOf(java.lang.CharSequence charSequence, int offset, char... characters) Compute the last index <= of given offset in the char sequence of one of given characters
static int	parseHexaString(java.lang.String string) Parse an hexadecimal string to integer
static int	parseInteger(java.lang.String string) Parse a string to integer
static java.lang.String	readUTF8(byte[] array, int offset, int length) Read a UTF-8 string from a part of byte array
static java.lang.String	removeWhiteCharacters(java.lang.String string) Remove all white characters of a string
static java.lang.String	repeat(char character, int time) Create a String full of same character
static java.lang.String	repeat(java.lang.String string, int time) Create string that repeat always the same string
static java.lang.String	replaceHole(java.lang.String originalString, java.lang.String... replacement) Replace "hole" by a value.
static java.lang.String	replaceSeveral(java.lang.String originalString, int... values) Replace holes like {0} or {2_s} or {1_###eet} or ...
static java.lang.String	toHexadecimal(byte[] array) Convert a byte array to hexadecimal representation
static byte[]	toUTF8(java.lang.String string) Convert string to UTF-8 array
static java.lang.String	upperCaseWithoutAccent(java.lang.String text) Compute the upper case version of of string, and remove all accent.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ESCAPE_CHARACTERS

public static final java.lang.String DEFAULT_ESCAPE_CHARACTERS

Default escape characters : \ (see StringExtractor)

See Also:

Constant Field Values

DEFAULT_SEPARATORS

public static final java.lang.String DEFAULT_SEPARATORS

Default escape separators : [space], [Line return \n], [tabulation \t], [carriage return \r] and [\f] (see StringExtractor)

See Also:

Constant Field Values

DEFAULT_STRING_LIMITERS

public static final java.lang.String DEFAULT_STRING_LIMITERS

Default string limiters : " and ' (see StringExtractor)

See Also:

Constant Field Values

UTF8

public static final java.nio.charset.Charset UTF8

UTF-8 char set

Constructor Detail

UtilText

private UtilText()

To avoid instance

Method Detail

appendObject

private static void appendObject(java.lang.StringBuffer stringBuffer,
                java.lang.Object object)

Append an object to string buffer

Parameters:

stringBuffer - Where append

object - Object to append

addAntiSlash

public static java.lang.String addAntiSlash(java.lang.String string,
                            boolean simpleQuote)

Add \ before each " we can chose do treat the ' as normal character or add \ before it also

Parameters:

string - String to replace

simpleQuote - Indicates if we also add \ before '

Returns:

Result string

capture

public static java.lang.String[] capture(java.lang.String pattern,
                         java.lang.String text)

colorText

public static java.lang.String colorText(int color)

Color to text representation

Parameters:

color - Color to convert

Returns:

Text representation

computeDistance

public static int computeDistance(java.lang.String text1,
                  java.lang.String text2,
                  boolean caseSensitive,
                  java.lang.String wordDelimiters)

Compute "distance" between two texts.
To compute how "far" are the tow texts, we take all words of each and if a word of one not exits in the other, we decide they are more far than if the word is in the second but not in the same place. If the word is in same place, we say distance is zero

Parameters:

text1 - First text

text2 - Second text

caseSensitive - Indicates if for word comparison case is important or not

wordDelimiters - List of delimiters of words (Each characters of this string are see as separator and only them)

Returns:

The computed distance

computeNotInsideName

public static java.lang.String computeNotInsideName(java.lang.String base,
                                    java.util.Collection<java.lang.String> names)

Compute a name not inside a set of name

Parameters:

base - Base name

names - Set of names

Returns:

Created name

computeOtherName

public static java.lang.String computeOtherName(java.lang.String name)

Compute an other name for a String name. It add a number or increase the number at the end of the String.
Use for auto generate names

Parameters:

name - Name base

Returns:

Computed name

concatenate

public static java.lang.String concatenate(java.lang.Object... objects)

Concatenate several object to make a string representation

Parameters:

objects - Objects to concatenate

Returns:

String representation

cutSringInPart

public static java.lang.String[] cutSringInPart(java.lang.String string,
                                char separator)

Cut String in several parts

Parameters:

string - String to cut

separator - Separator where cut

Returns:

Parts

indexOf

public static int indexOf(java.lang.CharSequence charSequence,
          char... characters)

Compute the first index in the char sequence of one of given characters

Parameters:

charSequence - Char sequence where search one character

characters - Characters search

Returns:

Index of the first character found in char sequence that inside in the given list. -1 if the char sequence doesn't contains any of given characters

indexOf

public static int indexOf(java.lang.CharSequence charSequence,
          int offset,
          char... characters)

Compute the first index >= at the given offset in the char sequence of one of given characters

Parameters:

charSequence - Char sequence where search one character

offset - The offset where start the search

characters - Characters search

Returns:

Index of the first character >= of given offset found in char sequence that inside in the given list. -1 if the char sequence doesn't contains any of given characters after the given offset

indexOf

public static int indexOf(java.lang.String[] tableau,
          java.lang.String chaine)

Index of a string in string array

Parameters:

tableau - Array where search

chaine - String search

Returns:

Index or -1 if not found

indexOfIgnoreString

public static int indexOfIgnoreString(java.lang.String string,
                      char character)

Compute the index of a character in a string on ignoring characters between " or ' an in ignore characters with \ just before them

Parameters:

string - String where search

character - Looking for character

Returns:

Index of character or -1 if not found

indexOfIgnoreStrings

public static int indexOfIgnoreStrings(java.lang.String text,
                       java.lang.String search,
                       int startIndex,
                       java.lang.String stringLimiters)

Give index of a string inside an other one on ignoring characters bettwen string delimiters.
By example you type:

The index will be 26 (not 6)

Parameters:

text - Text where search

search - Searched text

startIndex - Index where start the search

stringLimiters - String limiters to use

Returns:

Index found or -1 if not found

interpretAntiSlash

public static java.lang.String interpretAntiSlash(java.lang.String string)

Replace character that follow an \ by it's symbol : \n by carriage return, \t by tabulation and \<other> by <other>

Parameters:

string - String to replace

Returns:

Result string

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence charSequence,
              char... characters)

Compute the last index in the char sequence of one of given characters

Parameters:

charSequence - Char sequence where search one character

characters - Characters search

Returns:

Index of the last character found in char sequence that inside in the given list. -1 if the char sequence doesn't contains any of given characters

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence charSequence,
              int offset,
              char... characters)

Compute the last index <= of given offset in the char sequence of one of given characters

Parameters:

charSequence - Char sequence where search one character

offset - Offset maximum for search

characters - Characters search

Returns:

Index of the last character <= given offset found in char sequence that inside in the given list. -1 if the char sequence doesn't contains any of given characters before the given offset

parseHexaString

public static int parseHexaString(java.lang.String string)

Parse an hexadecimal string to integer

Parameters:

string - String to parse

Returns:

Integer

parseInteger

public static int parseInteger(java.lang.String string)

Parse a string to integer

Parameters:

string - String to parse

Returns:

Integer

readUTF8

public static java.lang.String readUTF8(byte[] array,
                        int offset,
                        int length)

Read a UTF-8 string from a part of byte array

Parameters:

array - Array to read

offset - Start read index in array

length - Number of bytes to read

Returns:

Read string

removeWhiteCharacters

public static java.lang.String removeWhiteCharacters(java.lang.String string)

Remove all white characters of a string

Parameters:

string - String to "clean"

Returns:

String without white characters

repeat

public static java.lang.String repeat(char character,
                      int time)

Create a String full of same character

Parameters:

character - Character to repeat

time - Number of character

Returns:

Created string

repeat

public static java.lang.String repeat(java.lang.String string,
                      int time)

Create string that repeat always the same string

Parameters:

string - String to repeat

time - Number of repeat

Returns:

Result string

replaceHole

public static java.lang.String replaceHole(java.lang.String originalString,
                           java.lang.String... replacement)

Replace "hole" by a value.
holes are like {0}, {8}, ... That means that the first replacement replace every holes {0}, then ninth every {8}, ...
Example:

originalString	replacement	result
I want exchange this {0} with this {1}	hammer, apple	I want exchange this hammer with this apple
I saw a {0} run after a {1}. I wonder if the {1} can escape from the {0}	dog, cat	I saw a dog run after a cat. I wonder if the cat can escape from the dog

Parameters:

originalString - String with "holes"

replacement - List of replacement for "holes". First replace hole {0}, second {1}, third {2} ,....

Returns:

Result string with replacement

replaceSeveral

public static java.lang.String replaceSeveral(java.lang.String originalString,
                              int... values)

Replace holes like {0} or {2_s} or {1_###eet} or ... depends of the given numbers.
If the word just before the {, need to be change if the number is at least 2, then put after the hole number the character _. If the rule is just to add a s, by example, like 1 cat, 2 cats, just put after the _, the letters to add. Example : cat{3_s}, means if the fourth number is under 2, the word will be cat and id the fourth number is 2 or more, the word will become cats. But it exist some case or just add letters is no enough, like 1 foot, 2 feet. In this case, just put some # character after the _ followed by the letters to add. The number of last letter you want remove from the original word corresponds to the number of # to put. By example, for foot become feet, we have to remove the 3 last letters (So have to put 3 #) then add letters "eet", so have to write : foot{2_###eet}. That's means if third number is under 2, foot is write, and if third number is 2 or over, foot is write, and 3 last letters are removed (Because of the 3 #) and "eet" is add, so its become feet. Examples:

originalString	replacement	result
There {0} cat{0_s} and {1} foot{1_###eet}	1, 1	There 1 cat and 1 foot
There {0} cat{0_s} and {1} foot{1_###eet}	5,1	There 5 cats and 1 foot
There {0} cat{0_s} and {1} foot{1_###eet}	1,3	There 1 cat and 3 feet
There {0} cat{0_s} and {1} foot{1_###eet}	5, 3	There 5 cats and 3 feet

Parameters:

originalString - String with "holes"

values - List of values for "holes". First evaluate hole {0}, second {1}, third {2} ,....

Returns:

Result string with replacement

toHexadecimal

public static java.lang.String toHexadecimal(byte[] array)

Convert a byte array to hexadecimal representation

Parameters:

array - Array to convert

Returns:

Hexadecimal representation

toUTF8

public static byte[] toUTF8(java.lang.String string)

Convert string to UTF-8 array

Parameters:

string - String to convert

Returns:

Converted string

upperCaseWithoutAccent

public static java.lang.String upperCaseWithoutAccent(java.lang.String text)

Compute the upper case version of of string, and remove all accent.

Parameters:

text - Text to upper case

Returns:

Upper case result