org.das2.jythoncompletion.nbadapt

Class CharSequenceUtilities

java.lang.Object

org.das2.jythoncompletion.nbadapt.CharSequenceUtilities

public final class CharSequenceUtilities
extends java.lang.Object

Utility methods related to character sequences.

Method Summary

Modifier and Type	Method and Description
static void	append(java.lang.StringBuffer sb, java.lang.CharSequence text) Append character sequence to the given string buffer.
static void	append(java.lang.StringBuffer sb, java.lang.CharSequence text, int start, int end) Append part of the character sequence to the given string buffer.
static void	checkIndexesValid(java.lang.CharSequence text, int start, int end) Ensure that the given start and end parameters are valid indices of the given text.
static void	checkIndexNonNegative(int index) Ensure that the given index is >=0 and lower than the given length.
static void	checkIndexValid(int index, int length) Ensure that the given index is >=0 and lower than the given length.
static java.lang.String	debugChar(char ch) Return the text description of the given character translating the special characters (and '\') into escape sequences.
static void	debugChar(java.lang.StringBuffer sb, char ch) Append the character description to the given string buffer translating the special characters (and '\') into escape sequences.
static void	debugChar(java.lang.StringBuilder sb, char ch) Append the character description to the given string builder translating the special characters (and '\') into escape sequences.
static java.lang.String	debugText(java.lang.CharSequence text) Create text description as String translating the special characters (and '\') into escape sequences.
static void	debugText(java.lang.StringBuffer sb, java.lang.CharSequence text) Append the text description to the given string buffer translating the special characters (and '\') into escape sequences.
static void	debugText(java.lang.StringBuilder sb, java.lang.CharSequence text) Append the text description to the given string builder translating the special characters (and '\') into escape sequences.
static boolean	endsWith(java.lang.CharSequence text, java.lang.CharSequence suffix) Implementation of String.endsWith(String) for character sequences.
static boolean	equals(java.lang.CharSequence text, java.lang.Object o) Compare character sequence to another object.
static int	indexOf(java.lang.CharSequence text, java.lang.CharSequence seq) Implementation of String.indexOf(String) for character sequences.
static int	indexOf(java.lang.CharSequence text, java.lang.CharSequence seq, int fromIndex) Implementation of String.indexOf(String,int) for character sequences.
static int	indexOf(java.lang.CharSequence text, int ch) Implementation of String.indexOf(int) for character sequences.
static int	indexOf(java.lang.CharSequence text, int ch, int fromIndex) Implementation of String.indexOf(int,int) for character sequences.
static int	lastIndexOf(java.lang.CharSequence text, java.lang.CharSequence seq) Implementation of String.lastIndexOf(String) for character sequences.
static int	lastIndexOf(java.lang.CharSequence text, java.lang.CharSequence seq, int fromIndex) Implementation of String.lastIndexOf(String,int) for character sequences.
static int	lastIndexOf(java.lang.CharSequence text, int ch) Implementation of String.lastIndexOf(int) for character sequences.
static int	lastIndexOf(java.lang.CharSequence text, int ch, int fromIndex) Implementation of String.lastIndexOf(int,int) for character sequences.
static boolean	startsWith(java.lang.CharSequence text, java.lang.CharSequence prefix) Implementation of String.startsWith(String) for character sequences.
static int	stringLikeHashCode(java.lang.CharSequence text) Compute String-like hashcode over given CharSequence.
static boolean	textEquals(java.lang.CharSequence text1, java.lang.CharSequence text2) Test whether whether the given character sequences represent the same text.
static java.lang.String	toString(java.lang.CharSequence text) Create a string from the given character sequence by first creating a StringBuilder and appending the whole character sequence to it.
static java.lang.String	toString(java.lang.CharSequence text, int start, int end) Create string for the given portion of the character sequence.
static java.lang.CharSequence	trim(java.lang.CharSequence text) Implementation of String.trim() for character sequences.

Methods inherited from class java.lang.Object

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

Method Detail

stringLikeHashCode

public static int stringLikeHashCode(java.lang.CharSequence text)

Compute String-like hashcode over given CharSequence.

Parameters:

text - character sequence for which the hashcode is being computed.

Returns:

hashcode of the given character sequence.

equals

public static boolean equals(java.lang.CharSequence text,
                             java.lang.Object o)

Compare character sequence to another object. The match is successful if the second object is a character sequence as well and both character sequences contain the same characters (or if both objects are null).

Parameters:

text - character sequence being compared to the given object. It may be null.

o - object to be compared to the character sequence. It may be null.

Returns:

true if both parameters are null or both are non-null and they contain the same text.

textEquals

public static boolean textEquals(java.lang.CharSequence text1,
                                 java.lang.CharSequence text2)

Test whether whether the given character sequences represent the same text.
The match is successful if the contained characters of the two character sequences are the same.

Parameters:

text1 - first character sequence being compared. It must not be null.

text2 - second character sequence being compared. It must not be null.

Returns:

true if both parameters are equal in String-like manner.

toString

public static java.lang.String toString(java.lang.CharSequence text)

Create a string from the given character sequence by first creating a StringBuilder and appending the whole character sequence to it.
The method does not call toString() on the given character sequence.

Parameters:

text - character sequence for which the String form should be created.

Returns:

string representation of the character sequence.

toString

public static java.lang.String toString(java.lang.CharSequence text,
                                        int start,
                                        int end)

Create string for the given portion of the character sequence.

Parameters:

text - non-null text.

start - >=0 and

end - >=start and

append

public static void append(java.lang.StringBuffer sb,
                          java.lang.CharSequence text)

Append character sequence to the given string buffer.
This method is no longer needed in JDK 1.5 where the implementation does not create an extra java.lang.String instance.

append

public static void append(java.lang.StringBuffer sb,
                          java.lang.CharSequence text,
                          int start,
                          int end)

Append part of the character sequence to the given string buffer.
This method is no longer needed in JDK 1.5 where the implementation of the same functionality is available in the StringBuffer directly.

indexOf

public static int indexOf(java.lang.CharSequence text,
                          int ch)

Implementation of String.indexOf(int) for character sequences.

indexOf

public static int indexOf(java.lang.CharSequence text,
                          int ch,
                          int fromIndex)

Implementation of String.indexOf(int,int) for character sequences.

indexOf

public static int indexOf(java.lang.CharSequence text,
                          java.lang.CharSequence seq)

Implementation of String.indexOf(String) for character sequences.

indexOf

public static int indexOf(java.lang.CharSequence text,
                          java.lang.CharSequence seq,
                          int fromIndex)

Implementation of String.indexOf(String,int) for character sequences.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence text,
                              java.lang.CharSequence seq)

Implementation of String.lastIndexOf(String) for character sequences.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence text,
                              java.lang.CharSequence seq,
                              int fromIndex)

Implementation of String.lastIndexOf(String,int) for character sequences.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence text,
                              int ch)

Implementation of String.lastIndexOf(int) for character sequences.

lastIndexOf

public static int lastIndexOf(java.lang.CharSequence text,
                              int ch,
                              int fromIndex)

Implementation of String.lastIndexOf(int,int) for character sequences.

startsWith

public static boolean startsWith(java.lang.CharSequence text,
                                 java.lang.CharSequence prefix)

Implementation of String.startsWith(String) for character sequences.

endsWith

public static boolean endsWith(java.lang.CharSequence text,
                               java.lang.CharSequence suffix)

Implementation of String.endsWith(String) for character sequences.

trim

public static java.lang.CharSequence trim(java.lang.CharSequence text)

Implementation of String.trim() for character sequences.

debugChar

public static void debugChar(java.lang.StringBuffer sb,
                             char ch)

Append the character description to the given string buffer translating the special characters (and '\') into escape sequences.

Parameters:

sb - non-null string buffer to append to.

ch - character to be debugged.

debugChar

public static void debugChar(java.lang.StringBuilder sb,
                             char ch)

Append the character description to the given string builder translating the special characters (and '\') into escape sequences.

Parameters:

sb - non-null string buffer to append to.

ch - character to be debugged.

debugChar

public static java.lang.String debugChar(char ch)

Return the text description of the given character translating the special characters (and '\') into escape sequences.

Parameters:

ch - char to debug.

Returns:

non-null debug text.

debugText

public static void debugText(java.lang.StringBuffer sb,
                             java.lang.CharSequence text)

Append the text description to the given string buffer translating the special characters (and '\') into escape sequences.

Parameters:

sb - non-null string buffer to append to.

text - non-null text to be debugged.

debugText

public static void debugText(java.lang.StringBuilder sb,
                             java.lang.CharSequence text)

Append the text description to the given string builder translating the special characters (and '\') into escape sequences.

Parameters:

sb - non-null string builder to append to.

text - non-null text to be debugged.

debugText

public static java.lang.String debugText(java.lang.CharSequence text)

Create text description as String translating the special characters (and '\') into escape sequences.

Parameters:

text - non-null text to be debugged.

Returns:

non-null string containing the debug text.

checkIndexNonNegative

public static void checkIndexNonNegative(int index)

Ensure that the given index is >=0 and lower than the given length.

Throws:

java.lang.IndexOutOfBoundsException - if the index is not within bounds.

checkIndexValid

public static void checkIndexValid(int index,
                                   int length)

Ensure that the given index is >=0 and lower than the given length.

Throws:

java.lang.IndexOutOfBoundsException - if the index is not within bounds.

checkIndexesValid

public static void checkIndexesValid(java.lang.CharSequence text,
                                     int start,
                                     int end)

Ensure that the given start and end parameters are valid indices of the given text.

Throws:

java.lang.IndexOutOfBoundsException - if the start or end are not within bounds of the given text.