Package org.apache.sis.util

Class StringBuilders

Object

Static

StringBuilders

public final class StringBuilders
extends Static

Static methods working on String­Builder instances. Some methods defined in this class duplicate the functionalities provided in the Char­Sequences class, but modify directly the content of the provided String­Builder instead than creating new objects.

Unicode support

Every methods defined in this class work on code points instead than characters when appropriate. Consequently those methods should behave correctly with characters outside the Basic Multilingual Plane (BMP).

Since:

0.3

See Also:

Char­Sequences

Defined in the sis-utility module

Method Summary

Modifier and Type	Method	Description
static void	remove(StringBuilder buffer, String toSearch)	Removes every occurrences of the given string in the given buffer.
static void	repeat(StringBuilder buffer, char c, int count)	Appends the given character n times.
static void	repeat(StringBuilder buffer, int offset, char c, int count)	Inserts the given character n times at the given position.
static void	replace(StringBuilder buffer, char toSearch, char replaceBy)	Replaces every occurrences of the given character in the given buffer.
static void	replace(StringBuilder buffer, int start, int end, char[] chars)	Replaces the characters in a substring of the buffer with characters in the specified array.
static void	replace(StringBuilder buffer, String toSearch, String replaceBy)	Replaces every occurrences of the given string in the given buffer.
static void	toASCII(StringBuilder buffer)	Replaces some Unicode characters by ASCII characters on a "best effort basis".
static void	trimFractionalPart(StringBuilder buffer)	Trims the fractional part of the given formatted number, provided that it doesn't change the value.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Method Detail

replace

public static void replace(StringBuilder buffer,
                           char toSearch,
                           char replaceBy)

Replaces every occurrences of the given character in the given buffer.

Parameters:

buffer - the string in which to perform the replacements.

to­Search - the character to replace.

replace­By - the replacement for the searched character.

Throws:

Null­Argument­Exception - if the buffer arguments is null.

See Also:

String.replace(char, char)

replace

public static void replace(StringBuilder buffer,
                           String toSearch,
                           String replaceBy)

Replaces every occurrences of the given string in the given buffer. This method invokes String­Builder.replace(int, int, String) for each occurrence of search found in the buffer.

Parameters:

buffer - the string in which to perform the replacements.

to­Search - the string to replace.

replace­By - the replacement for the searched string.

Throws:

Null­Argument­Exception - if any of the arguments is null.

Illegal­Argument­Exception - if the to­Search argument is empty.

See Also:

String.replace(char, char), Char­Sequences.replace(Char­Sequence, Char­Sequence, Char­Sequence), String­Builder.replace(int, int, String)

replace

public static void replace(StringBuilder buffer,
                           int start,
                           int end,
                           char[] chars)

Replaces the characters in a substring of the buffer with characters in the specified array. The substring to be replaced begins at the specified start and extends to the character at index end - 1.

Parameters:

buffer - the buffer in which to perform the replacement.

start - the beginning index in the buffer, inclusive.

end - the ending index in the buffer, exclusive.

chars - the array that will replace previous contents.

Throws:

Null­Argument­Exception - if the buffer or chars argument is null.

See Also:

String­Builder.replace(int, int, String)

remove

public static void remove(StringBuilder buffer,
                          String toSearch)

Removes every occurrences of the given string in the given buffer. This method invokes String­Builder.delete(int, int) for each occurrence of search found in the buffer.

Parameters:

buffer - the string in which to perform the removals.

to­Search - the string to remove.

Throws:

Null­Pointer­Exception - if any of the arguments is null.

Illegal­Argument­Exception - if the to­Search argument is empty.

See Also:

String­Builder.delete(int, int)

repeat

public static void repeat(StringBuilder buffer,
                          char c,
                          int count)

Appends the given character n times. This method does nothing if the given count is zero.

Parameters:

buffer - the buffer where to append the character.

c - the character to repeat.

count - number of times to repeat the given character.

Throws:

Null­Pointer­Exception - if the given buffer is null.

Illegal­Argument­Exception - if the given count is negative.

Since:

1.0

repeat

public static void repeat(StringBuilder buffer,
                          int offset,
                          char c,
                          int count)

Inserts the given character n times at the given position. This method does nothing if the given count is zero.

Parameters:

buffer - the buffer where to insert the character.

offset - position where to insert the characters.

c - the character to repeat.

count - number of times to repeat the given character.

Throws:

Null­Pointer­Exception - if the given buffer is null.

Index­Out­Of­Bounds­Exception - if the given index is invalid.

Illegal­Argument­Exception - if the given count is negative.

Since:

0.8

trimFractionalPart

public static void trimFractionalPart(StringBuilder buffer)

Trims the fractional part of the given formatted number, provided that it doesn't change the value. This method assumes that the number is formatted in the US locale, typically by the Double.to­String(double) method.

More specifically if the given buffer ends with a '.' character followed by a sequence of '0' characters, then those characters are removed. Otherwise this method does nothing. This is a "all or nothing" method: either the fractional part is completely removed, or either it is left unchanged.

Use case

This method is useful after a double value has been appended to the buffer, in order to make it appears like an integer when possible.

Parameters:

buffer - the buffer to trim if possible.

Throws:

Null­Argument­Exception - if the given buffer is null.

See Also:

Char­Sequences.trim­Fractional­Part(Char­Sequence)

toASCII

public static void toASCII(StringBuilder buffer)

Replaces some Unicode characters by ASCII characters on a "best effort basis". For example the “ é ” character is replaced by “ e ” (without accent), the “ ″ ” symbol for minutes of angle is replaced by straight double quotes “ " ”, and combined characters like ㎏, ㎎, ㎝, ㎞, ㎢, ㎦, ㎖, ㎧, ㎩, ㎐, etc. are replaced by the corresponding sequences of characters.

Parameters:

buffer - the text to scan for Unicode characters to replace by ASCII characters.

Throws:

Null­Argument­Exception - if the given buffer is null.

See Also:

Char­Sequences.to­ASCII(Char­Sequence), Normalizer.normalize(Char­Sequence, Normalizer.Form)