UnprotectedString (lecousin.net Java core framework 0.16.2 API)

java.lang.Object
- net.lecousin.framework.util.UnprotectedString

All Implemented Interfaces:

CharSequence, IString
```
public class UnprotectedString
extends Object
implements IString
```
Unprotected and mutable string. String in Java is immutable, and every modification or sub-string creates a new instance with a new character array. This means string manipulation has low performance because it implies many memory allocations, and copies. This is mainly because Java strings may be shared as constants. The class StringBuffer adds some modification capabilities and is enough is many situations, but this class provides additional capabilities to reuse character arrays.
This class simply wraps a character array, and add string functionalities on it.
It may be created with an existing character array, specifying the start offset to use, the current number of characters used, and the total number of characters that may be used.
For example, creating a sub-string of an UnprotectedString will just create a new UnprotectedString instance but sharing the same character array, with different offset and number of characters. That means modifying a character in an UnprotectedString will also modify the character in sub-strings.

Constructor Summary

Constructors
Constructor and Description
`UnprotectedString(char singleChar)` Create a string with a single character.
`UnprotectedString(char[] chars)` Create an UnprotectedString based on an existing character array.
`UnprotectedString(char[] chars, int offset, int len, int usableLength)` Create an UnprotectedString based on an existing character array.
`UnprotectedString(CharSequence s)` Creates an UnprotectedString from the given CharSequence (a copy of characters is done).
`UnprotectedString(int initialCapacity)` Create an empty UnprotectedString with an initial capacity.
`UnprotectedString(IString s)` Creates an UnprotectedString from the given String (a copy of characters is done).
`UnprotectedString(String s)` Creates an UnprotectedString from the given String (a copy of characters is done).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnprotectedString`	`append(char c)` Append a character.
`UnprotectedString`	`append(char[] chars, int offset, int len)` Append characters.
`UnprotectedString`	`append(CharSequence s)` Append characters.
`boolean`	`appendNoEnlarge(char c)` Append the given character without enlarging the char array, return false if it cannot be done.
`CharBuffer`	`asCharBuffer()` Create a CharBuffer wrapping the current string.
`CharBuffer[]`	`asCharBuffers()` Convert into an array of character buffers.
`int`	`canAppendWithoutEnlarging()` Return then number of unused characters at the end of the array.
`char[]`	`charArray()` Return the underlying character array.
`int`	`charArrayStart()` Return the current start offset in the underlying character array.
`char`	`charAt(int index)`
`int`	`countChar(char c)` Return the number of occurences of the given array in this string.
`boolean`	`endsWith(CharSequence end)` Return true if this string ends with the given one.
`int`	`fill(char[] chars, int start)` Fill the given character array with the content of this string.
`int`	`fillUsAsciiBytes(byte[] bytes, int start)` Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.
`int`	`firstChar()` Return the first character, or -1 if the string is empty.
`int`	`indexOf(char c, int pos)` Return the index of the first occurrence of the given character, starting at the given position, or -1 if not found.
`int`	`indexOf(CharSequence s, int pos)` Return the index of the first occurrence of the given CharSequence, starting at the given position, or -1 if not found.
`boolean`	`isEmpty()` Return true if empty (length == 0).
`int`	`lastChar()` Return the last character, or -1 if the string is empty.
`int`	`length()`
`void`	`moveForward(int skip)` Remove the given number of characters at the beginning of the string.
`UnprotectedString`	`removeEndChars(int nb)` Remove the given number of characters at the end.
`UnprotectedString`	`removeStartChars(int nb)` Remove the given number of characters at the beginning.
`UnprotectedString`	`replace(char oldChar, char newChar)` Replace all occurrences of oldChar into newChar.
`void`	`reset()` Make this string empty, only by setting the end offset to the start offset.
`void`	`setCharAt(int index, char c)` Set the character at the given index.
`List<UnprotectedString>`	`split(char sep)` Return a list of strings, by splitting the current string using the given character as separator.
`boolean`	`startsWith(CharSequence start)` Return true if this string starts with the given one.
`String`	`subSequence(int start, int end)`
`UnprotectedString`	`substring(int start)` Return a sub-string starting at the given position until the end.
`UnprotectedString`	`substring(int start, int end)` Return a sub-string starting at the given start position (included) until the given end position (excluded).
`UnprotectedString`	`toLowerCase()` Convert this string to lower case.
`String`	`toString()`
`UnprotectedString`	`toUpperCase()` Convert this string to upper case.
`UnprotectedString`	`trimBeginning()` Remove spaces characters at the beginning of this string.
`UnprotectedString`	`trimEnd()` Remove spaces characters at the end of this string.
`void`	`trimToSize()` Create a new character array to fit the current content of this string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.lecousin.framework.util.IString
append, asCharacters, asString, encode, equals, fill, fillUsAsciiBytes, indexOf, indexOf, isStartOf, toUsAsciiBytes, trim

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Constructor Detail
  - UnprotectedString
```
public UnprotectedString(int initialCapacity)
```
    Create an empty UnprotectedString with an initial capacity.
  - UnprotectedString
```
public UnprotectedString(char singleChar)
```
    Create a string with a single character.
  - UnprotectedString
```
public UnprotectedString(char[] chars,
                         int offset,
                         int len,
                         int usableLength)
```
    Create an UnprotectedString based on an existing character array.
  - UnprotectedString
```
public UnprotectedString(char[] chars)
```
    Create an UnprotectedString based on an existing character array.
  - UnprotectedString
```
public UnprotectedString(String s)
```
    Creates an UnprotectedString from the given String (a copy of characters is done).
  - UnprotectedString
```
public UnprotectedString(IString s)
```
    Creates an UnprotectedString from the given String (a copy of characters is done).
  - UnprotectedString
```
public UnprotectedString(CharSequence s)
```
    Creates an UnprotectedString from the given CharSequence (a copy of characters is done).
- Method Detail
  - length
```
public int length()
```
    Specified by:
    
    length in interface CharSequence
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: IString
    
    Return true if empty (length == 0).
    
    Specified by:
    
    isEmpty in interface IString
  - reset
```
public void reset()
```
    Make this string empty, only by setting the end offset to the start offset.
  - charAt
```
public char charAt(int index)
```
    Specified by:
    
    charAt in interface CharSequence
  - setCharAt
```
public void setCharAt(int index,
                      char c)
```
    Set the character at the given index.
    
    Specified by:
    
    setCharAt in interface IString
  - firstChar
```
public int firstChar()
```
    Return the first character, or -1 if the string is empty.
  - lastChar
```
public int lastChar()
```
    Return the last character, or -1 if the string is empty.
  - canAppendWithoutEnlarging
```
public int canAppendWithoutEnlarging()
```
    Return then number of unused characters at the end of the array.
  - trimToSize
```
public void trimToSize()
```
    Create a new character array to fit the current content of this string.
  - appendNoEnlarge
```
public boolean appendNoEnlarge(char c)
```
    Append the given character without enlarging the char array, return false if it cannot be done.
  - append
```
public UnprotectedString append(char c)
```
    Description copied from interface: IString
    
    Append a character.
    
    Specified by:
    
    append in interface IString
  - append
```
public UnprotectedString append(char[] chars,
                                int offset,
                                int len)
```
    Description copied from interface: IString
    
    Append characters.
    
    Specified by:
    
    append in interface IString
  - append
```
public UnprotectedString append(CharSequence s)
```
    Description copied from interface: IString
    
    Append characters.
    
    Specified by:
    
    append in interface IString
  - indexOf
```
public int indexOf(char c,
                   int pos)
```
    Description copied from interface: IString
    
    Return the index of the first occurrence of the given character, starting at the given position, or -1 if not found.
    
    Specified by:
    
    indexOf in interface IString
  - indexOf
```
public int indexOf(CharSequence s,
                   int pos)
```
    Description copied from interface: IString
    
    Return the index of the first occurrence of the given CharSequence, starting at the given position, or -1 if not found.
    
    Specified by:
    
    indexOf in interface IString
  - subSequence
```
public String subSequence(int start,
                          int end)
```
    Specified by:
    
    subSequence in interface CharSequence
  - substring
```
public UnprotectedString substring(int start,
                                   int end)
```
    Description copied from interface: IString
    
    Return a sub-string starting at the given start position (included) until the given end position (excluded).
    
    Specified by:
    
    substring in interface IString
  - substring
```
public UnprotectedString substring(int start)
```
    Description copied from interface: IString
    
    Return a sub-string starting at the given position until the end.
    
    Specified by:
    
    substring in interface IString
  - trimBeginning
```
public UnprotectedString trimBeginning()
```
    Description copied from interface: IString
    
    Remove spaces characters at the beginning of this string.
    
    Specified by:
    
    trimBeginning in interface IString
  - trimEnd
```
public UnprotectedString trimEnd()
```
    Description copied from interface: IString
    
    Remove spaces characters at the end of this string.
    
    Specified by:
    
    trimEnd in interface IString
  - replace
```
public UnprotectedString replace(char oldChar,
                                 char newChar)
```
    Description copied from interface: IString
    
    Replace all occurrences of oldChar into newChar.
    
    Specified by:
    
    replace in interface IString
  - removeEndChars
```
public UnprotectedString removeEndChars(int nb)
```
    Description copied from interface: IString
    
    Remove the given number of characters at the end.
    
    Specified by:
    
    removeEndChars in interface IString
  - removeStartChars
```
public UnprotectedString removeStartChars(int nb)
```
    Description copied from interface: IString
    
    Remove the given number of characters at the beginning.
    
    Specified by:
    
    removeStartChars in interface IString
  - moveForward
```
public void moveForward(int skip)
```
    Remove the given number of characters at the beginning of the string.
  - fill
```
public int fill(char[] chars,
                int start)
```
    Description copied from interface: IString
    
    Fill the given character array with the content of this string.
    
    Specified by:
    
    fill in interface IString
  - fillUsAsciiBytes
```
public int fillUsAsciiBytes(byte[] bytes,
                            int start)
```
    Description copied from interface: IString
    
    Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.
    
    Specified by:
    
    fillUsAsciiBytes in interface IString
  - split
```
public List<UnprotectedString> split(char sep)
```
    Description copied from interface: IString
    
    Return a list of strings, by splitting the current string using the given character as separator.
    
    Specified by:
    
    split in interface IString
  - toLowerCase
```
public UnprotectedString toLowerCase()
```
    Description copied from interface: IString
    
    Convert this string to lower case.
    
    Specified by:
    
    toLowerCase in interface IString
  - toUpperCase
```
public UnprotectedString toUpperCase()
```
    Description copied from interface: IString
    
    Convert this string to upper case.
    
    Specified by:
    
    toUpperCase in interface IString
  - startsWith
```
public boolean startsWith(CharSequence start)
```
    Description copied from interface: IString
    
    Return true if this string starts with the given one.
    
    Specified by:
    
    startsWith in interface IString
  - endsWith
```
public boolean endsWith(CharSequence end)
```
    Description copied from interface: IString
    
    Return true if this string ends with the given one.
    
    Specified by:
    
    endsWith in interface IString
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - asCharBuffer
```
public CharBuffer asCharBuffer()
```
    Create a CharBuffer wrapping the current string.
  - asCharBuffers
```
public CharBuffer[] asCharBuffers()
```
    Description copied from interface: IString
    
    Convert into an array of character buffers.
    
    Specified by:
    
    asCharBuffers in interface IString
  - charArray
```
public char[] charArray()
```
    Return the underlying character array.
  - charArrayStart
```
public int charArrayStart()
```
    Return the current start offset in the underlying character array.
  - countChar
```
public int countChar(char c)
```
    Return the number of occurences of the given array in this string.

Class UnprotectedString

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.lecousin.framework.util.IString

Methods inherited from interface java.lang.CharSequence

Constructor Detail

UnprotectedString

UnprotectedString

UnprotectedString

UnprotectedString

UnprotectedString

UnprotectedString

UnprotectedString

Method Detail

length

isEmpty

reset

charAt

setCharAt

firstChar

lastChar

canAppendWithoutEnlarging

trimToSize

appendNoEnlarge

append

append

append

indexOf

indexOf

subSequence

substring

substring

trimBeginning

trimEnd

replace

removeEndChars

removeStartChars

moveForward

fill

fillUsAsciiBytes

split

toLowerCase

toUpperCase

startsWith

endsWith

toString

asCharBuffer

asCharBuffers

charArray

charArrayStart

countChar