com.knowgate.stringutils

Class Str

java.lang.Object

com.knowgate.stringutils.Str

public class Str
extends Object

This file is licensed under the Apache License version 2.0. You may not use this file except in compliance with the license. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

Constructor Summary

Constructors

Constructor and Description
Str()

Method Summary

Modifier and Type	Method and Description
static String	capitalizeFirst(String sSource) Convert each letter after space to Upper Case and all others to Lower Case
static String	capitalizeFirstAndSecond(String sSource) Convert each letter after space to Upper Case if the word has exactly two characters then UpperCase also the second letter convert all other letters to Lower Case
static String	chomp(String sSource, String sEndsWith) Ensure that a String ends with a given substring
static String	dechomp(String sSource, char cEndsWith) Ensure that a String does not end with a given character
static boolean	in(String sStr, String[] aSet) Search for a String in an array
static int	indexOfIgnoreCase(String sSource, String sSought) Get index of a substring inside another string
static int	indexOfIgnoreCase(String sSource, String sSought, int iStartAt) Get index of a substring inside another string
static String	left(String sSource, int nChars) Get the leftmost characters of a String
static String	leftPad(String sSource, char cPad, int nChars) Add padding characters to the left.
static int	levenshteinDistance(String s, String t) Calculate Levenshtein distance between two strings
static String	removeChars(String sInput, String sRemove) Remove a character set from a String
static String	substrAfter(String sSource, int iFromIndex, String sSought) Get substring after a given character sequence
static String	substrBetween(String sSource, String sLowerBound, String sUpperBound) Get substring between two given character sequence
static String	substrUpTo(String sSource, int iFromIndex, char cSought) Get substring from an index up to next given character
static String	substrUpTo(String sSource, int iFromIndex, String sSought) Get substring from an index up to next given character sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

Str

public Str()

Method Detail

chomp

public static String chomp(String sSource,
                           String sEndsWith)

Ensure that a String ends with a given substring

Parameters:

sSource - Input String

sEndsWith - Substring that the String must end with.

Returns:

If sSource ends with sEndsWith then sSource is returned, else sSource+sEndsWith is returned.

dechomp

public static String dechomp(String sSource,
                             char cEndsWith)

Ensure that a String does not end with a given character

Parameters:

sSource - Input String

cEndsWith - Character that the String must not end with.

Returns:

If sSource does not end with sEndsWith then sSource is returned, else sSource-cEndsWith is returned.

in

public static boolean in(String sStr,
                         String[] aSet)

Search for a String in an array

Parameters:

sStr - String sought

aSet - String[] Strings searched

Returns:

boolean true if any String in set is equalsIgnoreCase to the given String.

removeChars

public static String removeChars(String sInput,
                                 String sRemove)

Remove a character set from a String

Parameters:

sInput - Input String

sRemove - A String containing all the characters to be removed from input String

Returns:

The input String without all the characters of sRemove

indexOfIgnoreCase

public static int indexOfIgnoreCase(String sSource,
                                    String sSought,
                                    int iStartAt)

Get index of a substring inside another string

Parameters:

sSource - String String to be scanned

sSought - Substring to be sought

iStartAt - int Index to start searching from

Returns:

int Start index of substring or -1 if not found

indexOfIgnoreCase

public static int indexOfIgnoreCase(String sSource,
                                    String sSought)

Get index of a substring inside another string

Parameters:

sSource - String String to be scanned

sSought - Substring to be sought

Returns:

int Start index of substring or -1 if not found

substrAfter

public static String substrAfter(String sSource,
                                 int iFromIndex,
                                 String sSought)
                          throws StringIndexOutOfBoundsException,
                                 NullPointerException

Get substring after a given character sequence

Parameters:

sSource - Source String

iFromIndex - Index top start searching character sequence from

sSought - Character sequence sought

Returns:

Substring after sSought character sequence. If source string is empty then return value is always an empty string. If sought substring is empty then return value is the whole source string. If sought substring is not found then return value is null

Throws:

StringIndexOutOfBoundsException

NullPointerException - is source or sought string is null

Since:

4.0

substrUpTo

public static String substrUpTo(String sSource,
                                int iFromIndex,
                                char cSought)
                         throws StringIndexOutOfBoundsException

Get substring from an index up to next given character

Parameters:

sSource - Source String

iFromIndex - Index top start searching character from

cSought - Character sought

Returns:

Substring between iFromIndex and cSought character

Throws:

StringIndexOutOfBoundsException - if cSought character is not found at sSource

Since:

4.0

substrUpTo

public static String substrUpTo(String sSource,
                                int iFromIndex,
                                String sSought)
                         throws StringIndexOutOfBoundsException

Get substring from an index up to next given character sequence

Parameters:

sSource - Source String

iFromIndex - Index top start searching character from

sSought - Character sequence sought

Returns:

Substring between iFromIndex and sSought

Throws:

StringIndexOutOfBoundsException - if sSought sequence is not found at sSource

Since:

4.0

substrBetween

public static String substrBetween(String sSource,
                                   String sLowerBound,
                                   String sUpperBound)
                            throws StringIndexOutOfBoundsException,
                                   NullPointerException

Get substring between two given character sequence

Parameters:

sSource - Source String

sLowerBound - Lower bound character sequence

sUpperBound - Upper bound character sequence

Returns:

Substring between sLowerBound and sUpperBound or null if either sLowerBound or sUpperBound are not found at sSource

Throws:

StringIndexOutOfBoundsException

NullPointerException

Since:

4.0

left

public static String left(String sSource,
                          int nChars)
                   throws ArrayIndexOutOfBoundsException

Get the leftmost characters of a String

Parameters:

sSource - Source String

nChars - Number of characters

Returns:

String

Throws:

ArrayIndexOutOfBoundsException - If nChars<0

leftPad

public static String leftPad(String sSource,
                             char cPad,
                             int nChars)

Add padding characters to the left.

Parameters:

sSource - Input String

cPad - Padding character

nChars - Final length of the padded string

Returns:

Padded String

levenshteinDistance

public static int levenshteinDistance(String s,
                                      String t)

Calculate Levenshtein distance between two strings

The Levenshtein distance is defined as the minimal number of characters you have to replace, insert or delete to transform s into t. The complexity of the algorithm is O(m*n), where n and m are the length of s and t.

Parameters:

s - String

t - String

Returns:

Levenshtein distance between s and t

Throws:

IllegalArgumentException - if either s or t is null

Since:

4.0

See Also:

Michael Gilleland & Chas Emerick

capitalizeFirst

public static String capitalizeFirst(String sSource)

Convert each letter after space to Upper Case and all others to Lower Case

Parameters:

sSource - Source String

Returns:

Replaced string or null if sSource if null

Since:

7.0

capitalizeFirstAndSecond

public static String capitalizeFirstAndSecond(String sSource)

Convert each letter after space to Upper Case if the word has exactly two characters then UpperCase also the second letter convert all other letters to Lower Case

Parameters:

sSource - Source String

Returns:

Replaced string or null if sSource if null

Since:

8.0