Keel 2.1RC2

org.keel.util.string
Class SuperString

java.lang.Object
  extended byorg.keel.util.string.SuperString
All Implemented Interfaces:
java.io.Serializable

public final class SuperString
extends java.lang.Object
implements java.io.Serializable

A fast string buffer implements a mutable sequence of characters.

SuperStrings are not thread-safe by themselves - be sure to synchronize

Every string buffer has a capacity. As long as the length of the character sequence contained in the string buffer does not exceed the capacity, it is not necessary to allocate a new internal buffer array. If the internal buffer overflows, it is automatically made larger.

See Also:
ByteArrayOutputStream, StringBuffer, Serialized Form

Field Summary
private  int count
          The count is the number of characters in the buffer.
private  boolean shared
          A flag indicating whether the buffer is shared
private  char[] value
          The value is used for character storage.
 
Constructor Summary
SuperString()
          Constructs an empty SuperString with no characters in it and an initial capacity of 16 characters.
SuperString(int length)
          Constructs a SuperString with no characters in it and an initial capacity specified by the length argument.
SuperString(java.lang.String originalString)
          Constructs a SuperString so that it represents the same sequence of characters as the string argument.
 
Method Summary
 SuperString append(boolean b)
          Appends the string representation of the boolean argument to the string buffer.
 SuperString append(char c)
          Appends the string representation of the char argument to this string buffer.
 SuperString append(char[] str)
          Appends the string representation of the char array argument to this string buffer.
 SuperString append(char[] str, int offset, int len)
          Appends the string representation of a subarray of the char array argument to this string buffer.
 SuperString append(double d)
          Appends the string representation of the double argument to this string buffer.
 SuperString append(float f)
          Appends the string representation of the float argument to this string buffer.
 SuperString append(int i)
          Appends the string representation of the int argument to this string buffer.
 SuperString append(long l)
          Appends the string representation of the long argument to this string buffer.
 SuperString append(java.lang.Object obj)
          Appends the string representation of the Object argument to this string buffer.
 SuperString append(java.lang.String str)
          Appends the string to this string buffer.
 SuperString append(SuperString str)
          Appends one SuperString to another so they can be merged with no unnecessary allocations
static void assertBoolean(java.lang.String theString, java.lang.String theMessage)
           
 void assertNotBlank()
           
 void assertNotBlank(java.lang.String theMessage)
           
static void assertNotBlank(java.lang.String theString, java.lang.String theMessage)
          Make sure any arbitrary string is not null.
 int capacity()
          Returns the current capacity of the String buffer.
 char charAt(int index)
          Returns the character at a specific index in this string buffer.
private  void copyWhenShared()
          Copies the buffer value if it is shared.
 void ensureCapacity(int minimumCapacity)
          Ensures that the capacity of the buffer is at least equal to the specified minimum.
 void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
          Characters are copied from this string buffer into the destination character array dst.
protected static java.lang.String getEntityRef(int ch)
          Helper to xmlEscape()
private  int getMonth(int[] partsAsInts, boolean monthFirst)
           
(package private)  char[] getValue()
           
private  java.lang.String isAmOrPm(java.lang.String s)
           
static boolean isNumber(java.lang.String stringToTest)
          Test to see if a String is a number.
static boolean isRealNumber(java.lang.String stringToTest)
          Test to see if a String is a real number.
private  boolean isSeperator(char c)
           
 int length()
          Returns the length (character count) of this string buffer.
static java.lang.String noNewLine(java.lang.String fieldValue)
           
static java.lang.String noQuotes(java.lang.String oldString)
          Utility method to return a string with all single quotes replaced with a pair of single quotes, and all double quotes also replaced with a pair of single quotes
static java.lang.String notNull(java.lang.String theString)
          Make sure a string is not null.
static java.lang.String notNull(SuperString theString)
          Same thing but using a serializable string as the parameter instead
static java.lang.String numberToLetter(int number, boolean upperCaseFlag)
          This method is useful for creating lists that use letters instead of numbers, such as a, b, c, d...instead of 1, 2, 3, 4.
protected static SuperString printEscaped(char ch, SuperString fsb)
          Formats a particular character to something workable in xml Helper to xmlEscape()
 java.lang.String replace(java.lang.String sub, java.lang.String with)
          replace substrings within string.
static java.lang.String replace(java.lang.String s, java.lang.String sub, java.lang.String with)
          replace substrings within string.
 SuperString reverse()
          The character sequence contained in this string buffer is replaced by the reverse of the sequence.
 void setCharAt(int index, char ch)
          The character at the specified index of this string buffer is set to ch.
 void setLength(int newLength)
          Sets the length of this String buffer.
(package private)  void setShared()
           
static boolean toBoolean(java.lang.String theString)
           
 java.util.Date toDate()
          Return the value of this SuperString as a java.util.Date.
 java.util.Date toDate(boolean monthFirst)
          Parse the current String contents as a date, if possible.
 java.lang.String toString()
          Converts to a string representing the data in this string buffer.
static java.lang.String xmlEscape(java.lang.String s)
          Formats the string to an XML/XHTML escaped character.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

value

private char[] value
The value is used for character storage.


count

private int count
The count is the number of characters in the buffer.


shared

private boolean shared
A flag indicating whether the buffer is shared

Constructor Detail

SuperString

public SuperString()
Constructs an empty SuperString with no characters in it and an initial capacity of 16 characters.


SuperString

public SuperString(int length)
Constructs a SuperString with no characters in it and an initial capacity specified by the length argument.

Parameters:
length - the initial capacity.
Throws:
java.lang.NegativeArraySizeException - if the length argument is less than 0.

SuperString

public SuperString(java.lang.String originalString)
Constructs a SuperString so that it represents the same sequence of characters as the string argument. The initial capacity of the string buffer is 16 plus the length of the string argument.

Method Detail

setShared

final void setShared()

getValue

final char[] getValue()

length

public int length()
Returns the length (character count) of this string buffer.

Returns:
the number of characters in this string buffer.

capacity

public int capacity()
Returns the current capacity of the String buffer. The capacity is the amount of storage available for newly inserted characters; beyond which an allocation will occur.

Returns:
the current capacity of this string buffer.

copyWhenShared

private final void copyWhenShared()
Copies the buffer value if it is shared.


ensureCapacity

public void ensureCapacity(int minimumCapacity)
Ensures that the capacity of the buffer is at least equal to the specified minimum. If the current capacity of this string buffer is less than the argument, then a new internal buffer is allocated with greater capacity. The new capacity is the larger of: If the minimumCapacity argument is nonpositive, this method takes no action and simply returns.

Parameters:
minimumCapacity - the minimum desired capacity.

setLength

public void setLength(int newLength)
Sets the length of this String buffer. If the newLength argument is less than the current length of the string buffer, the string buffer is truncated to contain exactly the number of characters given by the newLength argument.

If the newLength argument is greater than or equal to the current length, sufficient null characters ('\u0000') are appended to the string buffer so that length becomes the newLength argument.

The newLength argument must be greater than or equal to 0.

Parameters:
newLength - the new length of the buffer.
Throws:
java.lang.StringIndexOutOfBoundsException - if the newLength argument is invalid.
See Also:
StringBuffer.length()

charAt

public char charAt(int index)
Returns the character at a specific index in this string buffer.

The first character of a string buffer is at index 0, the next at index 1, and so on, for array indexing.

The index argument must be greater than or equal to 0, and less than the length of this string buffer.

Parameters:
index - the index of the desired character.
Returns:
the character at the specified index of this string buffer.
Throws:
java.lang.StringIndexOutOfBoundsException - if the index is invalid.
See Also:
StringBuffer.length()

getChars

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)
Characters are copied from this string buffer into the destination character array dst. The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1. The total number of characters to be copied is srcEnd-srcBegin. The characters are copied into the subarray of dst starting at index dstBegin and ending at index:

  dstbegin + (srcEnd-srcBegin) - 1
 

Parameters:
srcBegin - start copying at this offset in the string buffer.
srcEnd - stop copying at this offset in the string buffer.
dst - the array to copy the data into.
dstBegin - offset into dst.
Throws:
java.lang.StringIndexOutOfBoundsException - if there is an invalid index into the buffer.

setCharAt

public void setCharAt(int index,
                      char ch)
The character at the specified index of this string buffer is set to ch.

The offset argument must be greater than or equal to 0, and less than the length of this string buffer.

Parameters:
index - the index of the character to modify.
ch - the new character.
Throws:
java.lang.StringIndexOutOfBoundsException - if the index is invalid.
See Also:
StringBuffer.length()

append

public SuperString append(java.lang.Object obj)
Appends the string representation of the Object argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
obj - an Object.
Returns:
this string buffer.
See Also:
String.valueOf(java.lang.Object), StringBuffer.append(java.lang.String)

append

public SuperString append(java.lang.String str)
Appends the string to this string buffer.

The characters of the String argument are appended, in order, to the contents of this string buffer, increasing the length of this string buffer by the length of the argument.

Parameters:
str - a string.
Returns:
this string buffer.

append

public SuperString append(char[] str)
Appends the string representation of the char array argument to this string buffer.

The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument.

Parameters:
str - the characters to be appended.
Returns:
this string buffer.

append

public SuperString append(char[] str,
                          int offset,
                          int len)
Appends the string representation of a subarray of the char array argument to this string buffer.

Characters of the character array str, starting at index offset, are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of len.

Parameters:
str - the characters to be appended.
offset - the index of the first character to append.
len - the number of characters to append.
Returns:
this string buffer.

append

public SuperString append(SuperString str)
Appends one SuperString to another so they can be merged with no unnecessary allocations

Returns:
this string buffer

append

public SuperString append(boolean b)
Appends the string representation of the boolean argument to the string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
b - a boolean.
Returns:
this string buffer.
See Also:
String.valueOf(boolean), StringBuffer.append(java.lang.String)

append

public SuperString append(char c)
Appends the string representation of the char argument to this string buffer.

The argument is appended to the contents of this string buffer. The length of this string buffer increases by 1.

Returns:
this string buffer.

append

public SuperString append(int i)
Appends the string representation of the int argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
i - an int.
Returns:
this string buffer.
See Also:
String.valueOf(int), StringBuffer.append(java.lang.String)

append

public SuperString append(long l)
Appends the string representation of the long argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
l - a long.
Returns:
this string buffer.
See Also:
String.valueOf(long), StringBuffer.append(java.lang.String)

append

public SuperString append(float f)
Appends the string representation of the float argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
f - a float.
Returns:
this string buffer.
See Also:
String.valueOf(float), StringBuffer.append(java.lang.String)

append

public SuperString append(double d)
Appends the string representation of the double argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:
d - a double.
Returns:
this string buffer.
See Also:
String.valueOf(double), StringBuffer.append(java.lang.String)

reverse

public SuperString reverse()
The character sequence contained in this string buffer is replaced by the reverse of the sequence.

Returns:
this string buffer.

toString

public java.lang.String toString()
Converts to a string representing the data in this string buffer. A new String object is allocated and initialized to contain the character sequence currently represented by this string buffer. This String is then returned. Subsequent changes to the string buffer do not affect the contents of the String.

Returns:
a string representation of the string buffer.

toBoolean

public static boolean toBoolean(java.lang.String theString)

assertNotBlank

public void assertNotBlank()

assertNotBlank

public void assertNotBlank(java.lang.String theMessage)

assertNotBlank

public static void assertNotBlank(java.lang.String theString,
                                  java.lang.String theMessage)
Make sure any arbitrary string is not null. This allows us to use the assertNotBlank methods on ordinary strings

Parameters:
theString - Any string, possibly null
theMessage -

notNull

public static java.lang.String notNull(java.lang.String theString)
Make sure a string is not null.

Parameters:
theString - Any string, possibly null
Returns:
An empty string if the original was null, else the original

assertBoolean

public static void assertBoolean(java.lang.String theString,
                                 java.lang.String theMessage)

notNull

public static java.lang.String notNull(SuperString theString)
Same thing but using a serializable string as the parameter instead


numberToLetter

public static java.lang.String numberToLetter(int number,
                                              boolean upperCaseFlag)
                                       throws java.lang.Exception
This method is useful for creating lists that use letters instead of numbers, such as a, b, c, d...instead of 1, 2, 3, 4. Valid numbers are from 1 to 26, corresponding to the 26 letters of the alphabet. By default, the letter is returned as a lowercase, but if the boolean upperCaseFlag is true, the letter will be returned as an uppercase. Creation date: (5/11/00 12:52:23 PM) @author: Adam Rossi

Parameters:
number -
upperCaseFlag -
Returns:
java.lang.String
Throws:
java.lang.Exception

replace

public static java.lang.String replace(java.lang.String s,
                                       java.lang.String sub,
                                       java.lang.String with)
replace substrings within string.

Parameters:
s -
sub -
with -
Returns:

isNumber

public static boolean isNumber(java.lang.String stringToTest)
Test to see if a String is a number. By number, we mean an integer. Use isRealNumber if you want to consider floating point values as a number as well.


isRealNumber

public static boolean isRealNumber(java.lang.String stringToTest)
Test to see if a String is a real number. This means that both decimal and integer values are recognized.


replace

public java.lang.String replace(java.lang.String sub,
                                java.lang.String with)
replace substrings within string.

Parameters:
sub -
with -
Returns:

xmlEscape

public static java.lang.String xmlEscape(java.lang.String s)
Formats the string to an XML/XHTML escaped character.

Parameters:
s - the String to format
Returns:
The escaped formatted String.
See Also:
for example of original code.

printEscaped

protected static SuperString printEscaped(char ch,
                                          SuperString fsb)
Formats a particular character to something workable in xml Helper to xmlEscape()

Parameters:
ch - the character to print.
fsb - The SuperString to add this to.

getEntityRef

protected static java.lang.String getEntityRef(int ch)
Helper to xmlEscape()


noNewLine

public static java.lang.String noNewLine(java.lang.String fieldValue)

noQuotes

public static java.lang.String noQuotes(java.lang.String oldString)
Utility method to return a string with all single quotes replaced with a pair of single quotes, and all double quotes also replaced with a pair of single quotes

Parameters:
oldString - The original string
Returns:
The string modified as above

toDate

public java.util.Date toDate()
Return the value of this SuperString as a java.util.Date. When necessary, assume that the month is before the days, e.g. mm/dd. If you know that's not true, use toDate(false)

Returns:
The current string converted to a date, if possible.

toDate

public java.util.Date toDate(boolean monthFirst)
Parse the current String contents as a date, if possible. Will parse just about any date/time format, with any non-character separator.

Parameters:
monthFirst - If you know the month comes first. False means "best guess", but will still assume month first if the values are reasonable for this.
Returns:
A date, corresponding to the current string value.

isAmOrPm

private java.lang.String isAmOrPm(java.lang.String s)

getMonth

private int getMonth(int[] partsAsInts,
                     boolean monthFirst)

isSeperator

private boolean isSeperator(char c)

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.