Java Doc for AbstractStringBuilder.java in  » 6.0-JDK-Core » lang » java » lang » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » lang » java.lang 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.lang.AbstractStringBuilder

AbstractStringBuilder
abstract class AbstractStringBuilder implements Appendable,CharSequence(Code)
A mutable sequence of characters.

Implements a modifiable string. At any point in time it contains some particular sequence of characters, but the length and content of the sequence can be changed through certain method calls.
author:
   Michael McCloskey
version:
   1.22, 05/05/07
since:
   1.5



Field Summary
 intcount
     The count is the number of characters used.
 charvalue
     The value is used for character storage.

Constructor Summary
 AbstractStringBuilder()
     This no-arg constructor is necessary for serialization of subclasses.
 AbstractStringBuilder(int capacity)
     Creates an AbstractStringBuilder of the specified capacity.

Method Summary
public  AbstractStringBuilderappend(Object obj)
     Appends the string representation of the Object argument.

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 sequence.
Parameters:
  obj - an Object.

public  AbstractStringBuilderappend(String str)
     Appends the specified string to this character sequence.

The characters of the String argument are appended, in order, increasing the length of this sequence by the length of the argument.

public  AbstractStringBuilderappend(StringBuffer sb)
    
public  AbstractStringBuilderappend(CharSequence s)
    
public  AbstractStringBuilderappend(CharSequence s, int start, int end)
     Appends a subsequence of the specified CharSequence to this sequence.

Characters of the argument s, starting at index start, are appended, in order, to the contents of this sequence up to the (exclusive) index end.

public  AbstractStringBuilderappend(char str)
     Appends the string representation of the char array argument to this sequence.
public  AbstractStringBuilderappend(char str, int offset, int len)
     Appends the string representation of a subarray of the char array argument to this sequence.

Characters of the char array str, starting at index offset, are appended, in order, to the contents of this sequence.

public  AbstractStringBuilderappend(boolean b)
     Appends the string representation of the boolean argument to the sequence.

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 sequence.

public  AbstractStringBuilderappend(char c)
     Appends the string representation of the char argument to this sequence.
public  AbstractStringBuilderappend(int i)
     Appends the string representation of the int argument to this sequence.
public  AbstractStringBuilderappend(long l)
     Appends the string representation of the long argument to this sequence.

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 sequence.
Parameters:
  l - a long.

public  AbstractStringBuilderappend(float f)
     Appends the string representation of the float argument to this sequence.

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 sequence.
Parameters:
  f - a float.

public  AbstractStringBuilderappend(double d)
     Appends the string representation of the double argument to this sequence.

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 sequence.
Parameters:
  d - a double.

public  AbstractStringBuilderappendCodePoint(int codePoint)
     Appends the string representation of the codePoint argument to this sequence.
public  intcapacity()
     Returns the current capacity.
public  charcharAt(int index)
     Returns the char value in this sequence at the specified index. The first char value is at index 0, the next at index 1, and so on, as in array indexing.

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

If the char value specified by the index is a surrogate, the surrogate value is returned.
Parameters:
  index - the index of the desired char value.

public  intcodePointAt(int index)
     Returns the character (Unicode code point) at the specified index.
public  intcodePointBefore(int index)
     Returns the character (Unicode code point) before the specified index.
public  intcodePointCount(int beginIndex, int endIndex)
     Returns the number of Unicode code points in the specified text range of this sequence.
public  AbstractStringBuilderdelete(int start, int end)
     Removes the characters in a substring of this sequence. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the sequence if no such character exists.
public  AbstractStringBuilderdeleteCharAt(int index)
     Removes the char at the specified position in this sequence.
public  voidensureCapacity(int minimumCapacity)
     Ensures that the capacity is at least equal to the specified minimum. If the current capacity is less than the argument, then a new internal array is allocated with greater capacity.
 voidexpandCapacity(int minimumCapacity)
     This implements the expansion semantics of ensureCapacity with no size check or synchronization.
public  voidgetChars(int srcBegin, int srcEnd, char dst, int dstBegin)
     Characters are copied from this sequence into the destination character array dst.
final  char[]getValue()
     Needed by String for the contentEquals method.
public  intindexOf(String str)
     Returns the index within this string of the first occurrence of the specified substring.
public  intindexOf(String str, int fromIndex)
     Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.
public  AbstractStringBuilderinsert(int index, char str, int offset, int len)
     Inserts the string representation of a subarray of the str array argument into this sequence.
public  AbstractStringBuilderinsert(int offset, Object obj)
     Inserts the string representation of the Object argument into this character sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

public  AbstractStringBuilderinsert(int offset, String str)
     Inserts the string into this character sequence.

The characters of the String argument are inserted, in order, into this sequence at the indicated offset, moving up any characters originally above that position and increasing the length of this sequence by the length of the argument.

public  AbstractStringBuilderinsert(int offset, char str)
     Inserts the string representation of the char array argument into this sequence.

The characters of the array argument are inserted into the contents of this sequence at the position indicated by offset.

public  AbstractStringBuilderinsert(int dstOffset, CharSequence s)
     Inserts the specified CharSequence into this sequence.
public  AbstractStringBuilderinsert(int dstOffset, CharSequence s, int start, int end)
     Inserts a subsequence of the specified CharSequence into this sequence.

The subsequence of the argument s specified by start and end are inserted, in order, into this sequence at the specified destination offset, moving up any characters originally above that position.

public  AbstractStringBuilderinsert(int offset, boolean b)
     Inserts the string representation of the boolean argument into this sequence.
public  AbstractStringBuilderinsert(int offset, char c)
     Inserts the string representation of the char argument into this sequence.
public  AbstractStringBuilderinsert(int offset, int i)
     Inserts the string representation of the second int argument into this sequence.
public  AbstractStringBuilderinsert(int offset, long l)
     Inserts the string representation of the long argument into this sequence.
public  AbstractStringBuilderinsert(int offset, float f)
     Inserts the string representation of the float argument into this sequence.
public  AbstractStringBuilderinsert(int offset, double d)
     Inserts the string representation of the double argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

public  intlastIndexOf(String str)
     Returns the index within this string of the rightmost occurrence of the specified substring.
public  intlastIndexOf(String str, int fromIndex)
     Returns the index within this string of the last occurrence of the specified substring.
public  intlength()
     Returns the length (character count).
public  intoffsetByCodePoints(int index, int codePointOffset)
     Returns the index within this sequence that is offset from the given index by codePointOffset code points.
public  AbstractStringBuilderreplace(int start, int end, String str)
     Replaces the characters in a substring of this sequence with characters in the specified String.
public  AbstractStringBuilderreverse()
     Causes this character sequence to be replaced by the reverse of the sequence.
public  voidsetCharAt(int index, char ch)
     The character at the specified index is set to ch.
public  voidsetLength(int newLength)
     Sets the length of the character sequence. The sequence is changed to a new character sequence whose length is specified by the argument.
public  CharSequencesubSequence(int start, int end)
     Returns a new character sequence that is a subsequence of this sequence.

An invocation of this method of the form

 sb.subSequence(begin, end)
behaves in exactly the same way as the invocation
 sb.substring(begin, end)
This method is provided so that this class can implement the CharSequence interface.
public  Stringsubstring(int start)
     Returns a new String that contains a subsequence of characters currently contained in this character sequence.
public  Stringsubstring(int start, int end)
     Returns a new String that contains a subsequence of characters currently contained in this sequence.
abstract public  StringtoString()
     Returns a string representing the data in this sequence. A new String object is allocated and initialized to contain the character sequence currently represented by this object.
public  voidtrimToSize()
     Attempts to reduce storage used for the character sequence. If the buffer is larger than necessary to hold its current sequence of characters, then it may be resized to become more space efficient.

Field Detail
count
int count(Code)
The count is the number of characters used.



value
char value(Code)
The value is used for character storage.




Constructor Detail
AbstractStringBuilder
AbstractStringBuilder()(Code)
This no-arg constructor is necessary for serialization of subclasses.



AbstractStringBuilder
AbstractStringBuilder(int capacity)(Code)
Creates an AbstractStringBuilder of the specified capacity.




Method Detail
append
public AbstractStringBuilder append(Object obj)(Code)
Appends the string representation of the Object argument.

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 sequence.
Parameters:
  obj - an Object. a reference to this object.




append
public AbstractStringBuilder append(String str)(Code)
Appends the specified string to this character sequence.

The characters of the String argument are appended, in order, increasing the length of this sequence by the length of the argument. If str is null, then the four characters "null" are appended.

Let n be the length of this character sequence just prior to execution of the append method. Then the character at index k in the new character sequence is equal to the character at index k in the old character sequence, if k is less than n; otherwise, it is equal to the character at index k-n in the argument str.
Parameters:
  str - a string. a reference to this object.




append
public AbstractStringBuilder append(StringBuffer sb)(Code)



append
public AbstractStringBuilder append(CharSequence s)(Code)



append
public AbstractStringBuilder append(CharSequence s, int start, int end)(Code)
Appends a subsequence of the specified CharSequence to this sequence.

Characters of the argument s, starting at index start, are appended, in order, to the contents of this sequence up to the (exclusive) index end. The length of this sequence is increased by the value of end - start.

Let n be the length of this character sequence just prior to execution of the append method. Then the character at index k in this character sequence becomes equal to the character at index k in this sequence, if k is less than n; otherwise, it is equal to the character at index k+start-n in the argument s.

If s is null, then this method appends characters as if the s parameter was a sequence containing the four characters "null".
Parameters:
  s - the sequence to append.
Parameters:
  start - the starting index of the subsequence to be appended.
Parameters:
  end - the end index of the subsequence to be appended. a reference to this object.
throws:
  IndexOutOfBoundsException - ifstart or end are negative, orstart is greater than end orend is greater than s.length()




append
public AbstractStringBuilder append(char str)(Code)
Appends the string representation of the char array argument to this sequence.

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

The overall effect is exactly as if the argument were converted to a string by the method String.valueOf(char[]) and the characters of that string were then AbstractStringBuilder.append(String) appended to this character sequence.
Parameters:
  str - the characters to be appended. a reference to this object.




append
public AbstractStringBuilder append(char str, int offset, int len)(Code)
Appends the string representation of a subarray of the char array argument to this sequence.

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

The overall effect is exactly as if the arguments were converted to a string by the method String.valueOf(char[]intint) and the characters of that string were then AbstractStringBuilder.append(String) appended to this character sequence.
Parameters:
  str - the characters to be appended.
Parameters:
  offset - the index of the first char to append.
Parameters:
  len - the number of chars to append. a reference to this object.




append
public AbstractStringBuilder append(boolean b)(Code)
Appends the string representation of the boolean argument to the sequence.

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 sequence.
Parameters:
  b - a boolean. a reference to this object.




append
public AbstractStringBuilder append(char c)(Code)
Appends the string representation of the char argument to this sequence.

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

The overall effect is exactly as if the argument were converted to a string by the method String.valueOf(char) and the character in that string were then AbstractStringBuilder.append(String) appended to this character sequence.
Parameters:
  c - a char. a reference to this object.




append
public AbstractStringBuilder append(int i)(Code)
Appends the string representation of the int argument to this sequence.

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 sequence.
Parameters:
  i - an int. a reference to this object.




append
public AbstractStringBuilder append(long l)(Code)
Appends the string representation of the long argument to this sequence.

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 sequence.
Parameters:
  l - a long. a reference to this object.




append
public AbstractStringBuilder append(float f)(Code)
Appends the string representation of the float argument to this sequence.

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 sequence.
Parameters:
  f - a float. a reference to this object.




append
public AbstractStringBuilder append(double d)(Code)
Appends the string representation of the double argument to this sequence.

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 sequence.
Parameters:
  d - a double. a reference to this object.




appendCodePoint
public AbstractStringBuilder appendCodePoint(int codePoint)(Code)
Appends the string representation of the codePoint argument to this sequence.

The argument is appended to the contents of this sequence. The length of this sequence increases by Character.charCount(int) Character.charCount(codePoint) .

The overall effect is exactly as if the argument were converted to a char array by the method Character.toChars(int) and the character in that array were then AbstractStringBuilder.append(char[]) appended to this character sequence.
Parameters:
  codePoint - a Unicode code point a reference to this object.
exception:
  IllegalArgumentException - if the specifiedcodePoint isn't a valid Unicode code point




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



charAt
public char charAt(int index)(Code)
Returns the char value in this sequence at the specified index. The first char value is at index 0, the next at index 1, and so on, as in array indexing.

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

If the char value specified by the index is a surrogate, the surrogate value is returned.
Parameters:
  index - the index of the desired char value. the char value at the specified index.
throws:
  IndexOutOfBoundsException - if index is negative or greater than or equal to length().




codePointAt
public int codePointAt(int index)(Code)
Returns the character (Unicode code point) at the specified index. The index refers to char values (Unicode code units) and ranges from 0 to AbstractStringBuilder.length() - 1.

If the char value specified at the given index is in the high-surrogate range, the following index is less than the length of this sequence, and the char value at the following index is in the low-surrogate range, then the supplementary code point corresponding to this surrogate pair is returned. Otherwise, the char value at the given index is returned.
Parameters:
  index - the index to the char values the code point value of the character at theindex
exception:
  IndexOutOfBoundsException - if the indexargument is negative or not less than the length of thissequence.




codePointBefore
public int codePointBefore(int index)(Code)
Returns the character (Unicode code point) before the specified index. The index refers to char values (Unicode code units) and ranges from 1 to AbstractStringBuilder.length() .

If the char value at (index - 1) is in the low-surrogate range, (index - 2) is not negative, and the char value at (index - 2) is in the high-surrogate range, then the supplementary code point value of the surrogate pair is returned. If the char value at index - 1 is an unpaired low-surrogate or a high-surrogate, the surrogate value is returned.
Parameters:
  index - the index following the code point that should be returned the Unicode code point value before the given index.
exception:
  IndexOutOfBoundsException - if the indexargument is less than 1 or greater than the lengthof this sequence.




codePointCount
public int codePointCount(int beginIndex, int endIndex)(Code)
Returns the number of Unicode code points in the specified text range of this sequence. The text range begins at the specified beginIndex and extends to the char at index endIndex - 1. Thus the length (in chars) of the text range is endIndex-beginIndex. Unpaired surrogates within this sequence count as one code point each.
Parameters:
  beginIndex - the index to the first char ofthe text range.
Parameters:
  endIndex - the index after the last char ofthe text range. the number of Unicode code points in the specified textrange
exception:
  IndexOutOfBoundsException - if thebeginIndex is negative, or endIndexis larger than the length of this sequence, orbeginIndex is larger than endIndex.



delete
public AbstractStringBuilder delete(int start, int end)(Code)
Removes the characters in a substring of this sequence. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the sequence if no such character exists. If start is equal to end, no changes are made.
Parameters:
  start - The beginning index, inclusive.
Parameters:
  end - The ending index, exclusive. This object.
throws:
  StringIndexOutOfBoundsException - if startis negative, greater than length(), orgreater than end.



deleteCharAt
public AbstractStringBuilder deleteCharAt(int index)(Code)
Removes the char at the specified position in this sequence. This sequence is shortened by one char.

Note: If the character at the given index is a supplementary character, this method does not remove the entire character. If correct handling of supplementary characters is required, determine the number of chars to remove by calling Character.charCount(thisSequence.codePointAt(index)), where thisSequence is this sequence.
Parameters:
  index - Index of char to remove This object.
throws:
  StringIndexOutOfBoundsException - if the indexis negative or greater than or equal tolength().




ensureCapacity
public void ensureCapacity(int minimumCapacity)(Code)
Ensures that the capacity is at least equal to the specified minimum. If the current capacity is less than the argument, then a new internal array is allocated with greater capacity. The new capacity is the larger of:
  • The minimumCapacity argument.
  • Twice the old capacity, plus 2.
If the minimumCapacity argument is nonpositive, this method takes no action and simply returns.
Parameters:
  minimumCapacity - the minimum desired capacity.



expandCapacity
void expandCapacity(int minimumCapacity)(Code)
This implements the expansion semantics of ensureCapacity with no size check or synchronization.



getChars
public void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code)
Characters are copied from this sequence 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.
Parameters:
  srcEnd - stop copying at this offset.
Parameters:
  dst - the array to copy the data into.
Parameters:
  dstBegin - offset into dst.
throws:
  NullPointerException - if dst is null.
throws:
  IndexOutOfBoundsException - if any of the following is true:
  • srcBegin is negative
  • dstBegin is negative
  • the srcBegin argument is greater than the srcEnd argument.
  • srcEnd is greater than this.length().
  • dstBegin+srcEnd-srcBegin is greater than dst.length



getValue
final char[] getValue()(Code)
Needed by String for the contentEquals method.



indexOf
public int indexOf(String str)(Code)
Returns the index within this string of the first occurrence of the specified substring. The integer returned is the smallest value k such that:
 this.toString().startsWith(str, k)
 
is true.
Parameters:
  str - any string. if the string argument occurs as a substring within thisobject, then the index of the first character of the firstsuch substring is returned; if it does not occur as asubstring, -1 is returned.
throws:
  java.lang.NullPointerException - if str is null.



indexOf
public int indexOf(String str, int fromIndex)(Code)
Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. The integer returned is the smallest value k for which:
 k >= Math.min(fromIndex, str.length()) &&
 this.toString().startsWith(str, k)
 
If no such value of k exists, then -1 is returned.
Parameters:
  str - the substring for which to search.
Parameters:
  fromIndex - the index from which to start the search. the index within this string of the first occurrence of thespecified substring, starting at the specified index.
throws:
  java.lang.NullPointerException - if str isnull.



insert
public AbstractStringBuilder insert(int index, char str, int offset, int len)(Code)
Inserts the string representation of a subarray of the str array argument into this sequence. The subarray begins at the specified offset and extends len chars. The characters of the subarray are inserted into this sequence at the position indicated by index. The length of this sequence increases by len chars.
Parameters:
  index - position at which to insert subarray.
Parameters:
  str - A char array.
Parameters:
  offset - the index of the first char in subarray tobe inserted.
Parameters:
  len - the number of chars in the subarray tobe inserted. This object
throws:
  StringIndexOutOfBoundsException - if indexis negative or greater than length(), oroffset or len are negative, or(offset+len) is greater thanstr.length.



insert
public AbstractStringBuilder insert(int offset, Object obj)(Code)
Inserts the string representation of the Object argument into this character sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  obj - an Object. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, String str)(Code)
Inserts the string into this character sequence.

The characters of the String argument are inserted, in order, into this sequence at the indicated offset, moving up any characters originally above that position and increasing the length of this sequence by the length of the argument. If str is null, then the four characters "null" are inserted into this sequence.

The character at index k in the new character sequence is equal to:

  • the character at index k in the old character sequence, if k is less than offset
  • the character at index k-offset in the argument str, if k is not less than offset but is less than offset+str.length()
  • the character at index k-str.length() in the old character sequence, if k is not less than offset+str.length()

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  str - a string. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, char str)(Code)
Inserts the string representation of the char array argument into this sequence.

The characters of the array argument are inserted into the contents of this sequence at the position indicated by offset. The length of this sequence increases by the length of the argument.

The overall effect is exactly as if the argument were converted to a string by the method String.valueOf(char[]) and the characters of that string were then AbstractStringBuilder.insert(int,String) inserted into this character sequence at the position indicated by offset.
Parameters:
  offset - the offset.
Parameters:
  str - a character array. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int dstOffset, CharSequence s)(Code)
Inserts the specified CharSequence into this sequence.

The characters of the CharSequence argument are inserted, in order, into this sequence at the indicated offset, moving up any characters originally above that position and increasing the length of this sequence by the length of the argument s.

The result of this method is exactly the same as if it were an invocation of this object's insert(dstOffset, s, 0, s.length()) method.

If s is null, then the four characters "null" are inserted into this sequence.
Parameters:
  dstOffset - the offset.
Parameters:
  s - the sequence to be inserted a reference to this object.
throws:
  IndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int dstOffset, CharSequence s, int start, int end)(Code)
Inserts a subsequence of the specified CharSequence into this sequence.

The subsequence of the argument s specified by start and end are inserted, in order, into this sequence at the specified destination offset, moving up any characters originally above that position. The length of this sequence is increased by end - start.

The character at index k in this sequence becomes equal to:

  • the character at index k in this sequence, if k is less than dstOffset
  • the character at index k+start-dstOffset in the argument s, if k is greater than or equal to dstOffset but is less than dstOffset+end-start
  • the character at index k-(end-start) in this sequence, if k is greater than or equal to dstOffset+end-start

The dstOffset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

The start argument must be nonnegative, and not greater than end.

The end argument must be greater than or equal to start, and less than or equal to the length of s.

If s is null, then this method inserts characters as if the s parameter was a sequence containing the four characters "null".
Parameters:
  dstOffset - the offset in this sequence.
Parameters:
  s - the sequence to be inserted.
Parameters:
  start - the starting index of the subsequence to be inserted.
Parameters:
  end - the end index of the subsequence to be inserted. a reference to this object.
throws:
  IndexOutOfBoundsException - if dstOffsetis negative or greater than this.length(), orstart or end are negative, orstart is greater than end orend is greater than s.length()




insert
public AbstractStringBuilder insert(int offset, boolean b)(Code)
Inserts the string representation of the boolean argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  b - a boolean. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, char c)(Code)
Inserts the string representation of the char argument into this sequence.

The second argument is inserted into the contents of this sequence at the position indicated by offset. The length of this sequence increases by one.

The overall effect is exactly as if the argument were converted to a string by the method String.valueOf(char) and the character in that string were then AbstractStringBuilder.insert(int,String) inserted into this character sequence at the position indicated by offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  c - a char. a reference to this object.
throws:
  IndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, int i)(Code)
Inserts the string representation of the second int argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  i - an int. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, long l)(Code)
Inserts the string representation of the long argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the position indicated by offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  l - a long. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, float f)(Code)
Inserts the string representation of the float argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  f - a float. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




insert
public AbstractStringBuilder insert(int offset, double d)(Code)
Inserts the string representation of the double argument into this sequence.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
Parameters:
  offset - the offset.
Parameters:
  d - a double. a reference to this object.
throws:
  StringIndexOutOfBoundsException - if the offset is invalid.




lastIndexOf
public int lastIndexOf(String str)(Code)
Returns the index within this string of the rightmost occurrence of the specified substring. The rightmost empty string "" is considered to occur at the index value this.length(). The returned index is the largest value k such that
 this.toString().startsWith(str, k)
 
is true.
Parameters:
  str - the substring to search for. if the string argument occurs one or more times as a substringwithin this object, then the index of the first character ofthe last such substring is returned. If it does not occur asa substring, -1 is returned.
throws:
  java.lang.NullPointerException - if str is null.



lastIndexOf
public int lastIndexOf(String str, int fromIndex)(Code)
Returns the index within this string of the last occurrence of the specified substring. The integer returned is the largest value k such that:
 k <= Math.min(fromIndex, str.length()) &&
 this.toString().startsWith(str, k)
 
If no such value of k exists, then -1 is returned.
Parameters:
  str - the substring to search for.
Parameters:
  fromIndex - the index to start the search from. the index within this sequence of the last occurrence of thespecified substring.
throws:
  java.lang.NullPointerException - if str is null.



length
public int length()(Code)
Returns the length (character count). the length of the sequence of characters currently represented by this object



offsetByCodePoints
public int offsetByCodePoints(int index, int codePointOffset)(Code)
Returns the index within this sequence that is offset from the given index by codePointOffset code points. Unpaired surrogates within the text range given by index and codePointOffset count as one code point each.
Parameters:
  index - the index to be offset
Parameters:
  codePointOffset - the offset in code points the index within this sequence
exception:
  IndexOutOfBoundsException - if indexis negative or larger then the length of this sequence,or if codePointOffset is positive and the subsequencestarting with index has fewer thancodePointOffset code points,or if codePointOffset is negative and the subsequencebefore index has fewer than the absolute value ofcodePointOffset code points.



replace
public AbstractStringBuilder replace(int start, int end, String str)(Code)
Replaces the characters in a substring of this sequence with characters in the specified String. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the sequence if no such character exists. First the characters in the substring are removed and then the specified String is inserted at start. (This sequence will be lengthened to accommodate the specified String if necessary.)
Parameters:
  start - The beginning index, inclusive.
Parameters:
  end - The ending index, exclusive.
Parameters:
  str - String that will replace previous contents. This object.
throws:
  StringIndexOutOfBoundsException - if startis negative, greater than length(), orgreater than end.



reverse
public AbstractStringBuilder reverse()(Code)
Causes this character sequence to be replaced by the reverse of the sequence. If there are any surrogate pairs included in the sequence, these are treated as single characters for the reverse operation. Thus, the order of the high-low surrogates is never reversed. Let n be the character length of this character sequence (not the length in char values) just prior to execution of the reverse method. Then the character at index k in the new character sequence is equal to the character at index n-k-1 in the old character sequence.

Note that the reverse operation may result in producing surrogate pairs that were unpaired low-surrogates and high-surrogates before the operation. For example, reversing "\uDC00\uD800" produces "\uD800\uDC00" which is a valid surrogate pair. a reference to this object.




setCharAt
public void setCharAt(int index, char ch)(Code)
The character at the specified index is set to ch. This sequence is altered to represent a new character sequence that is identical to the old character sequence, except that it contains the character ch at position index.

The index argument must be greater than or equal to 0, and less than the length of this sequence.
Parameters:
  index - the index of the character to modify.
Parameters:
  ch - the new character.
throws:
  IndexOutOfBoundsException - if index is negative or greater than or equal to length().




setLength
public void setLength(int newLength)(Code)
Sets the length of the character sequence. The sequence is changed to a new character sequence whose length is specified by the argument. For every nonnegative index k less than newLength, the character at index k in the new character sequence is the same as the character at index k in the old sequence if k is less than the length of the old character sequence; otherwise, it is the null character '\u0000'. In other words, if the newLength argument is less than the current length, the length is changed to the specified length.

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

The newLength argument must be greater than or equal to 0.
Parameters:
  newLength - the new length
throws:
  IndexOutOfBoundsException - if thenewLength argument is negative.




subSequence
public CharSequence subSequence(int start, int end)(Code)
Returns a new character sequence that is a subsequence of this sequence.

An invocation of this method of the form

 sb.subSequence(begin, end)
behaves in exactly the same way as the invocation
 sb.substring(begin, end)
This method is provided so that this class can implement the CharSequence interface.


Parameters:
  start - the start index, inclusive.
Parameters:
  end - the end index, exclusive. the specified subsequence.
throws:
  IndexOutOfBoundsException - if start or end are negative,if end is greater than length(),or if start is greater than end



substring
public String substring(int start)(Code)
Returns a new String that contains a subsequence of characters currently contained in this character sequence. The substring begins at the specified index and extends to the end of this sequence.
Parameters:
  start - The beginning index, inclusive. The new string.
throws:
  StringIndexOutOfBoundsException - if start isless than zero, or greater than the length of this object.



substring
public String substring(int start, int end)(Code)
Returns a new String that contains a subsequence of characters currently contained in this sequence. The substring begins at the specified start and extends to the character at index end - 1.
Parameters:
  start - The beginning index, inclusive.
Parameters:
  end - The ending index, exclusive. The new string.
throws:
  StringIndexOutOfBoundsException - if startor end are negative or greater thanlength(), or start isgreater than end.



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



trimToSize
public void trimToSize()(Code)
Attempts to reduce storage used for the character sequence. If the buffer is larger than necessary to hold its current sequence of characters, then it may be resized to become more space efficient. Calling this method may, but is not required to, affect the value returned by a subsequent call to the AbstractStringBuilder.capacity() method.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.