|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.keel.util.string.SuperString
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.
ByteArrayOutputStream, StringBuffer, Serialized Form| Field Summary | |
private int |
countThe count is the number of characters in the buffer. |
private boolean |
sharedA flag indicating whether the buffer is shared |
private char[] |
valueThe 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 |
private char[] value
private int count
private boolean shared
| Constructor Detail |
public SuperString()
public SuperString(int length)
length argument.
length - the initial capacity.java.lang.NegativeArraySizeException - if the length argument is less than 0.public SuperString(java.lang.String originalString)
16 plus the length of the string argument.
| Method Detail |
final void setShared()
final char[] getValue()
public int length()
public int capacity()
private final void copyWhenShared()
public void ensureCapacity(int minimumCapacity)
minimumCapacity argument.2.minimumCapacity argument is nonpositive, this method takes no action and simply returns.
minimumCapacity - the minimum desired capacity.public void setLength(int newLength)
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.
newLength - the new length of the buffer.java.lang.StringIndexOutOfBoundsException - if the newLength argument is invalid.StringBuffer.length()public char charAt(int index)
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.
index - the index of the desired character.java.lang.StringIndexOutOfBoundsException - if the index is invalid.StringBuffer.length()
public void getChars(int srcBegin,
int srcEnd,
char[] dst,
int dstBegin)
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
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.java.lang.StringIndexOutOfBoundsException - if there is an invalid index into the buffer.
public void setCharAt(int index,
char ch)
ch.
The offset argument must be greater than or equal to 0, and less than the length of this string buffer.
index - the index of the character to modify.ch - the new character.java.lang.StringIndexOutOfBoundsException - if the index is invalid.StringBuffer.length()public SuperString append(java.lang.Object obj)
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.
obj - an Object.String.valueOf(java.lang.Object), StringBuffer.append(java.lang.String)public SuperString append(java.lang.String str)
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.
str - a string.public SuperString append(char[] str)
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.
str - the characters to be appended.
public SuperString append(char[] str,
int offset,
int len)
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.
str - the characters to be appended.offset - the index of the first character to append.len - the number of characters to append.public SuperString append(SuperString str)
public SuperString append(boolean b)
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.
b - a boolean.String.valueOf(boolean), StringBuffer.append(java.lang.String)public SuperString append(char c)
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.
public SuperString append(int i)
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.
i - an int.String.valueOf(int), StringBuffer.append(java.lang.String)public SuperString append(long l)
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.
l - a long.String.valueOf(long), StringBuffer.append(java.lang.String)public SuperString append(float f)
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.
f - a float.String.valueOf(float), StringBuffer.append(java.lang.String)public SuperString append(double d)
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.
d - a double.String.valueOf(double), StringBuffer.append(java.lang.String)public SuperString reverse()
public java.lang.String toString()
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.
public static boolean toBoolean(java.lang.String theString)
public void assertNotBlank()
public void assertNotBlank(java.lang.String theMessage)
public static void assertNotBlank(java.lang.String theString,
java.lang.String theMessage)
theString - Any string, possibly nulltheMessage -public static java.lang.String notNull(java.lang.String theString)
theString - Any string, possibly null
public static void assertBoolean(java.lang.String theString,
java.lang.String theMessage)
public static java.lang.String notNull(SuperString theString)
public static java.lang.String numberToLetter(int number,
boolean upperCaseFlag)
throws java.lang.Exception
number -upperCaseFlag -java.lang.Exception
public static java.lang.String replace(java.lang.String s,
java.lang.String sub,
java.lang.String with)
s -sub -with -public static boolean isNumber(java.lang.String stringToTest)
public static boolean isRealNumber(java.lang.String stringToTest)
public java.lang.String replace(java.lang.String sub,
java.lang.String with)
sub -with -public static java.lang.String xmlEscape(java.lang.String s)
s - the String to formatfor example of original code.
protected static SuperString printEscaped(char ch,
SuperString fsb)
ch - the character to print.fsb - The SuperString to add this to.protected static java.lang.String getEntityRef(int ch)
public static java.lang.String noNewLine(java.lang.String fieldValue)
public static java.lang.String noQuotes(java.lang.String oldString)
oldString - The original stringpublic java.util.Date toDate()
public java.util.Date toDate(boolean monthFirst)
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.private java.lang.String isAmOrPm(java.lang.String s)
private int getMonth(int[] partsAsInts,
boolean monthFirst)
private boolean isSeperator(char c)
|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||