Class ReplaceableString

java.lang.Object
com.ibm.icu.text.ReplaceableString
All Implemented Interfaces:
Replaceable

public class ReplaceableString extends Object implements Replaceable
ReplaceableString is an adapter class that implements the Replaceable API around an ordinary StringBuffer.

Note: This class does not support attributes and is not intended for general use. Most clients will need to implement Replaceable in their text representation class.

Author:
Alan Liu
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    Construct a new empty object.
    Construct a new object with the given initial contents.
    Construct a new object using buf for internal storage.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    char32At(int offset)
    Return the 32-bit code point at the given 16-bit offset into the text.
    char
    charAt(int offset)
    Return the character at the given position in this object.
    void
    copy(int start, int limit, int dest)
    Copy a substring of this object, retaining attribute (out-of-band) information.
    void
    getChars(int srcStart, int srcLimit, char[] dst, int dstStart)
    Copies characters from this object into the destination character array.
    boolean
    Implements Replaceable
    int
    Return the number of characters contained in this object.
    void
    replace(int start, int limit, char[] chars, int charsStart, int charsLen)
    Replace a substring of this object with the given text.
    void
    replace(int start, int limit, String text)
    Replace zero or more characters with new characters.
    substring(int start, int limit)
    Return a substring of the given string.
    Return the contents of this object as a String.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ReplaceableString

      public ReplaceableString(String str)
      Construct a new object with the given initial contents.
      Parameters:
      str - initial contents
    • ReplaceableString

      public ReplaceableString(StringBuffer buf)
      Construct a new object using buf for internal storage. The contents of buf at the time of construction are used as the initial contents. Note! Modifications to buf will modify this object, and vice versa.
      Parameters:
      buf - object to be used as internal storage
    • ReplaceableString

      public ReplaceableString()
      Construct a new empty object.
  • Method Details

    • toString

      public String toString()
      Return the contents of this object as a String.
      Overrides:
      toString in class Object
      Returns:
      string contents of this object
    • substring

      public String substring(int start, int limit)
      Return a substring of the given string.
    • length

      public int length()
      Return the number of characters contained in this object. Replaceable API.
      Specified by:
      length in interface Replaceable
      Returns:
      number of 16-bit code units in text
    • charAt

      public char charAt(int offset)
      Return the character at the given position in this object. Replaceable API.
      Specified by:
      charAt in interface Replaceable
      Parameters:
      offset - offset into the contents, from 0 to length() - 1
      Returns:
      16-bit code unit of text at given offset
    • char32At

      public int char32At(int offset)
      Return the 32-bit code point at the given 16-bit offset into the text. This assumes the text is stored as 16-bit code units with surrogate pairs intermixed. If the offset of a leading or trailing code unit of a surrogate pair is given, return the code point of the surrogate pair.
      Specified by:
      char32At in interface Replaceable
      Parameters:
      offset - an integer between 0 and length()-1 inclusive
      Returns:
      32-bit code point of text at given offset
    • getChars

      public void getChars(int srcStart, int srcLimit, char[] dst, int dstStart)
      Copies characters from this object into the destination character array. The first character to be copied is at index srcStart; the last character to be copied is at index srcLimit-1 (thus the total number of characters to be copied is srcLimit-srcStart). The characters are copied into the subarray of dst starting at index dstStart and ending at index dstStart + (srcLimit-srcStart) - 1.
      Specified by:
      getChars in interface Replaceable
      Parameters:
      srcStart - the beginning index to copy, inclusive; 0 <= start <= limit.
      srcLimit - the ending index to copy, exclusive; start <= limit <= length().
      dst - the destination array.
      dstStart - the start offset in the destination array.
    • replace

      public void replace(int start, int limit, String text)
      Replace zero or more characters with new characters. Replaceable API.
      Specified by:
      replace in interface Replaceable
      Parameters:
      start - the beginning index, inclusive; 0 <= start <= limit.
      limit - the ending index, exclusive; start <= limit <= length().
      text - new text to replace characters start to limit - 1
    • replace

      public void replace(int start, int limit, char[] chars, int charsStart, int charsLen)
      Replace a substring of this object with the given text.
      Specified by:
      replace in interface Replaceable
      Parameters:
      start - the beginning index, inclusive; 0 <= start <= limit.
      limit - the ending index, exclusive; start <= limit <= length().
      chars - the text to replace characters start to limit - 1
      charsStart - the beginning index into chars, inclusive; 0 <= start <= limit.
      charsLen - the number of characters of chars.
    • copy

      public void copy(int start, int limit, int dest)
      Copy a substring of this object, retaining attribute (out-of-band) information. This method is used to duplicate or reorder substrings. The destination index must not overlap the source range.
      Specified by:
      copy in interface Replaceable
      Parameters:
      start - the beginning index, inclusive; 0 <= start <= limit.
      limit - the ending index, exclusive; start <= limit <= length().
      dest - the destination index. The characters from start..limit-1 will be copied to dest. Implementations of this method may assume that dest <= start || dest >= limit.
    • hasMetaData

      public boolean hasMetaData()
      Implements Replaceable
      Specified by:
      hasMetaData in interface Replaceable
      Returns:
      true if this object contains metadata