net.lecousin.framework.util

Interface IString

All Superinterfaces:

CharSequence

All Known Implementing Classes:

UnprotectedString, UnprotectedStringBuffer, UnprotectedStringBufferLimited

public interface IString
extends CharSequence

Interface adding functionalities to CharSequence.

Method Summary

Modifier and Type	Method and Description
IString	append(char c) Append a character.
default IString	append(char[] chars) Append characters.
IString	append(char[] chars, int offset, int len) Append characters.
IString	append(CharSequence s) Append characters.
default char[][]	asCharacters() Convert into an array of character arrays.
CharBuffer[]	asCharBuffers() Convert into an array of character buffers.
default String	asString() Convert this string into a Java string.
default ByteBuffer	encode(Charset cs) Encode this string into a ByteBuffer using the specified charset.
boolean	endsWith(CharSequence end) Return true if this string ends with the given one.
default boolean	equals(CharSequence s) Compare the given CharSequence with this string.
default int	fill(char[] chars) Fill the given character array with the content of this string.
int	fill(char[] chars, int start) Fill the given character array with the content of this string.
default int	fillUsAsciiBytes(byte[] bytes) Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.
int	fillUsAsciiBytes(byte[] bytes, int start) Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.
default int	indexOf(char c) Return the index of the first occurrence of the given character, or -1 if not found.
int	indexOf(char c, int start) Return the index of the first occurrence of the given character, starting at the given position, or -1 if not found.
default int	indexOf(CharSequence s) Return the index of the first occurrence of the given CharSequence, or -1 if not found.
int	indexOf(CharSequence s, int start) 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).
default boolean	isStartOf(CharSequence s) Return true if this string is a start for the given one.
IString	removeEndChars(int nb) Remove the given number of characters at the end.
IString	removeStartChars(int nb) Remove the given number of characters at the beginning.
IString	replace(char oldChar, char newChar) Replace all occurrences of oldChar into newChar.
void	setCharAt(int index, char c) Set a character.
List<? extends IString>	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.
IString	substring(int start) Return a sub-string starting at the given position until the end.
IString	substring(int start, int end) Return a sub-string starting at the given start position (included) until the given end position (excluded).
IString	toLowerCase() Convert this string to lower case.
IString	toUpperCase() Convert this string to upper case.
default byte[]	toUsAsciiBytes() Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.
default IString	trim() Remove spaces characters at the beginning and the end of this string, and return this instance.
IString	trimBeginning() Remove spaces characters at the beginning of this string.
IString	trimEnd() Remove spaces characters at the end of this string.

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence, toString

Method Detail

isEmpty

boolean isEmpty()

Return true if empty (length == 0).

setCharAt

void setCharAt(int index,
               char c)

Set a character.

append

IString append(char c)

Append a character.

append

IString append(char[] chars,
               int offset,
               int len)

Append characters.

append

default IString append(char[] chars)

Append characters.

append

IString append(CharSequence s)

Append characters.

indexOf

int indexOf(char c,
            int start)

Return the index of the first occurrence of the given character, starting at the given position, or -1 if not found.

indexOf

int indexOf(CharSequence s,
            int start)

Return the index of the first occurrence of the given CharSequence, starting at the given position, or -1 if not found.

indexOf

default int indexOf(char c)

Return the index of the first occurrence of the given character, or -1 if not found.

indexOf

default int indexOf(CharSequence s)

Return the index of the first occurrence of the given CharSequence, or -1 if not found.

substring

IString substring(int start)

Return a sub-string starting at the given position until the end.

substring

IString substring(int start,
                  int end)

Return a sub-string starting at the given start position (included) until the given end position (excluded).

fill

int fill(char[] chars,
         int start)

Fill the given character array with the content of this string.

fill

default int fill(char[] chars)

Fill the given character array with the content of this string.

fillUsAsciiBytes

int fillUsAsciiBytes(byte[] bytes,
                     int start)

Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.

fillUsAsciiBytes

default int fillUsAsciiBytes(byte[] bytes)

Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.

toUsAsciiBytes

default byte[] toUsAsciiBytes()

Same as with char but with bytes, all characters are directly converted into bytes without CharsetEncoder.

trimBeginning

IString trimBeginning()

Remove spaces characters at the beginning of this string.

trimEnd

IString trimEnd()

Remove spaces characters at the end of this string.

trim

default IString trim()

Remove spaces characters at the beginning and the end of this string, and return this instance.

replace

IString replace(char oldChar,
                char newChar)

Replace all occurrences of oldChar into newChar.

removeEndChars

IString removeEndChars(int nb)

Remove the given number of characters at the end.

removeStartChars

IString removeStartChars(int nb)

Remove the given number of characters at the beginning.

toLowerCase

IString toLowerCase()

Convert this string to lower case.

toUpperCase

IString toUpperCase()

Convert this string to upper case.

split

List<? extends IString> split(char sep)

Return a list of strings, by splitting the current string using the given character as separator.

equals

default boolean equals(CharSequence s)

Compare the given CharSequence with this string.

startsWith

boolean startsWith(CharSequence start)

Return true if this string starts with the given one.

endsWith

boolean endsWith(CharSequence end)

Return true if this string ends with the given one.

isStartOf

default boolean isStartOf(CharSequence s)

Return true if this string is a start for the given one. This string's length must be less or equal to the start's length.

asString

default String asString()

Convert this string into a Java string.

asCharacters

default char[][] asCharacters()

Convert into an array of character arrays.

asCharBuffers

CharBuffer[] asCharBuffers()

Convert into an array of character buffers.

encode

default ByteBuffer encode(Charset cs)
                   throws CharacterCodingException

Encode this string into a ByteBuffer using the specified charset.

Throws:

CharacterCodingException