CharSeq (icefig 0.2.4 API)

java.lang.Object
- com.worksap.fig.lang.CharSeq

public class CharSeq
extends java.lang.Object

Elegant supplement for String in JDK

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharSeq`	`capitalize()` Returns a copy of CharSeq with the string's first character converted to uppercase and the remainder to lowercase.
`java.lang.Character`	`charAt(int i)` Return the Character at the index i of this CharSeq
`int`	`compareTo(CharSeq another)` Compares two CharSeqs lexicographically.
`int`	`compareToIgnoreCase(CharSeq another)` Compares two CharSeqs lexicographically ignore case differences.
`CharSeq`	`concat(CharSeq another)` Append string of the given CharSeq to this CharSeq
`CharSeq`	`concat(java.lang.String another)` Append the given string to this CharSeq
`boolean`	`containsSubSeq(CharSeq seq)` Check whether this CharSeq contains the sub seq, if the given seq is empty, always return true.
`boolean`	`containsSubSeq(java.lang.String seq)` Check whether this CharSeq contains the sub seq, if the given seq is empty, always return true.
`Seq<java.lang.Byte>`	`eachByte()` Encodes this `CharSeq` into a sequence of bytes using the platform's default charset, storing the result into a new Byte Seq.
`Seq<java.lang.Character>`	`eachChar()` Converts this CharSeq to a new Character Seq.
`Seq<java.lang.Integer>`	`eachCodePoint()` Returns the collection of the Unicode of each character in this `CharSeq`.
`Seq<CharSeq>`	`eachLine()` Split the CharSeq by the newline character and return the result as a Seq of CharSeq.
`boolean`	`endsWith(CharSeq suffix)` Tests whether this CharSeq ends with the specified suffix
`boolean`	`endsWith(java.lang.String suffix)` Tests whether this CharSeq ends with the specified suffix
`boolean`	`equals(java.lang.Object another)`
`CharSeq`	`forEachByte(java.util.function.BiConsumer<java.lang.Byte,java.lang.Integer> action)` Performs the given action for each byte of the CharSeq, with additional parameter "index" as the second parameter.
`CharSeq`	`forEachByte(java.util.function.Consumer<java.lang.Byte> action)` Performs the given action for each byte of the CharSeq.
`CharSeq`	`forEachChar(java.util.function.BiConsumer<java.lang.Character,java.lang.Integer> action)` Performs the given action for each character of the CharSeq, with additional parameter "index" as the second parameter.
`CharSeq`	`forEachChar(java.util.function.Consumer<java.lang.Character> action)` Performs the given action for each character of the CharSeq.
`CharSeq`	`forEachCodePoint(java.util.function.Consumer<java.lang.Integer> consumer)` Takes action on the Unicode of each character in this `CharSeq`.
`CharSeq`	`forEachLine(java.util.function.BiConsumer<CharSeq,java.lang.Integer> action)` Performs the given action for each line of the CharSeq, with additional parameter "index" as the second parameter.
`CharSeq`	`forEachLine(java.util.function.Consumer<CharSeq> action)` Performs the given action for each line of the CharSeq.
`int`	`indexOfSubSeq(CharSeq seq)` Return the first index of the given sub seq, or -1 if the given seq is not a sub seq.
`int`	`indexOfSubSeq(java.lang.String seq)` Return the first index of the given sub seq, or -1 if the given seq is not a sub seq.
`boolean`	`isEmpty()` Returns `true` if, and only if, `length()` is `0`.
`int`	`lastIndexOfSubSeq(CharSeq seq)` Return the last index of the given sub seq, or -1 if the given seq is not a sub seq.
`int`	`lastIndexOfSubSeq(java.lang.String seq)` Return the last index of the given sub seq, or -1 if the given seq is not a sub seq.
`int`	`length()` Returns the length of string of this CharSeq.
`boolean`	`matches(java.lang.String regex)` Tells whether or not this CharSeq matches the given regular expression.
`static CharSeq`	`of(char[] charArr)` Construct a new CharSeq with the given char array
`static CharSeq`	`of(java.lang.String str)` Construct a new CharSeq with the given string
`Seq<CharSeq>`	`partition(java.lang.String regex)` Searches pattern (regex) in the CharSeq and returns a Seq of CharSeq consists of the part before it, the first match, and the part after it.
`CharSeq`	`prepend(CharSeq another)` Prepend string of the given CharSeq to this CharSeq
`CharSeq`	`prepend(java.lang.String another)` Prepend the given string to this CharSeq
`CharSeq`	`replaceAll(java.lang.String regex, CharSeq replacement)` Return a new CharSeq by replacing each substring of this CharSeq that matches the given regular expression with the given CharSeq replacement.
`CharSeq`	`replaceAll(java.lang.String regex, java.lang.String replacement)` Return a new CharSeq by replacing each substring of this CharSeq that matches the given regular expression with the given String replacement.
`CharSeq`	`replaceFirst(java.lang.String regex, CharSeq replacement)` Return a new CharSeq by replacing the first substring of this CharSeq that matches the given regular expression with the given CharSeq replacement.
`CharSeq`	`replaceFirst(java.lang.String regex, java.lang.String replacement)` Return a new CharSeq by replacing the first substring of this CharSeq that matches the given regular expression with the given String replacement.
`CharSeq`	`reverse()` Return a new CharSeq with the characters from this CharSeq in reverse order.
`Seq<CharSeq>`	`rPartition(java.lang.String regex)` Searches pattern (regex) in the CharSeq and returns a Seq of CharSeq consists of the part before it, the last match, and the part after it.
`Seq<CharSeq>`	`scan(java.lang.String regex)` Scan through this CharSeq iteratively, generate a Seq of CharSeq with all the matching subStrings.
`Seq<CharSeq>`	`split(java.lang.String regex)` Splits this CharSeq around matches of the given regular expression.
`boolean`	`startsWith(CharSeq prefix)` Tests whether this CharSeq starts with the specified prefix
`CharSeq`	`subSeq(int fromIndex)` Returns a CharSeq that contains a substring of this CharSeq's string.
`CharSeq`	`subSeq(int fromIndex, int toIndex)` Returns a CharSeq that contains a substring of this CharSeq's string.
`CharSeq`	`swapcase()` Return a new CharSeq with all characters' cases toggled.
`CharSeq`	`toLowerCase()` Returns a copy of this CharSeq with characters all converted to lowercase.
`java.lang.String`	`toString()`
`CharSeq`	`toUpperCase()` Returns a copy of CharSeq with the string's characters all converted to uppercase.
`CharSeq`	`trim()` Returns a CharSeq whose value is this CharSeq, with any leading and trailing whitespace removed.

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

- Method Detail
  - subSeq
```
public CharSeq subSeq(int fromIndex,
                      int toIndex)
```
    Returns a CharSeq that contains a substring of this CharSeq's string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex.
    
    Examples:
    CharSeq.of("hamburger").subSeq(4, 8) returns CharSeq.of("urge") CharSeq.of("smiles").subSeq(1, 5) returns CharSeq.of("mile")
    Parameters:
    
    fromIndex - the beginning index, inclusive.
    
    toIndex - the ending index, exclusive.
    
    Returns:
    
    CharSeq with the specified substring.
  - subSeq
```
public CharSeq subSeq(int fromIndex)
```
    Returns a CharSeq that contains a substring of this CharSeq's string. The substring begins at the specified beginIndex and extends to the end of this string.
    
    Examples:
    CharSeq.of("unhappy").subSeq(2) returns CharSeq.of("happy") CharSeq.of("Harbison").subSeq(3) returns CharSeq.of("bison")
    Parameters:
    
    fromIndex - the beginning index, inclusive.
    
    Returns:
    
    CharSeq with the specified substring.
  - concat
```
public CharSeq concat(CharSeq another)
```
    Append string of the given CharSeq to this CharSeq
    
    Parameters:
    
    another - the given CharSeq
    
    Returns:
    
    appended result
  - concat
```
public CharSeq concat(java.lang.String another)
```
    Append the given string to this CharSeq
    
    Parameters:
    
    another - the given string
    
    Returns:
    
    appended result
  - prepend
```
public CharSeq prepend(CharSeq another)
```
    Prepend string of the given CharSeq to this CharSeq
    
    Parameters:
    
    another - the given string
    
    Returns:
    
    prepended result
  - prepend
```
public CharSeq prepend(java.lang.String another)
```
    Prepend the given string to this CharSeq
    
    Parameters:
    
    another - the given string
    
    Returns:
    
    prepended result
  - length
```
public int length()
```
    Returns the length of string of this CharSeq. The length is equal to the number of Unicode code units in the string.
    
    Returns:
    
    the length
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if, and only if, length() is 0.
    
    Returns:
    
    true if length() is 0, otherwise false
  - capitalize
```
public CharSeq capitalize()
```
    Returns a copy of CharSeq with the string's first character converted to uppercase and the remainder to lowercase.
    
    Returns:
    
    CharSeq with capitalized string
  - toUpperCase
```
public CharSeq toUpperCase()
```
    Returns a copy of CharSeq with the string's characters all converted to uppercase.
    
    Returns:
  - toLowerCase
```
public CharSeq toLowerCase()
```
    Returns a copy of this CharSeq with characters all converted to lowercase.
    
    Returns:
  - split
```
public Seq<CharSeq> split(java.lang.String regex)
```
    Splits this CharSeq around matches of the given regular expression.
    
    Parameters:
    
    regex - Regular expression
    
    Returns:
  - of
```
public static CharSeq of(java.lang.String str)
```
    Construct a new CharSeq with the given string
    
    Parameters:
    
    str - the given string
    
    Returns:
  - of
```
public static CharSeq of(char[] charArr)
```
    Construct a new CharSeq with the given char array
    
    Parameters:
    
    charArr - the given char array
    
    Returns:
  - reverse
```
public CharSeq reverse()
```
    Return a new CharSeq with the characters from this CharSeq in reverse order.
    
    Examples:
    CharSeq.of("stressed").reverse() returns CharSeq.of("desserts")
    Returns:
    
    A new Seq
  - swapcase
```
public CharSeq swapcase()
```
    Return a new CharSeq with all characters' cases toggled.
    
    Examples:
    CharSeq.of("sTrEsSed").swapcase() returns CharSeq.of("StReSsED")
    Returns:
    
    A new CharSeq
  - endsWith
```
public boolean endsWith(CharSeq suffix)
```
    Tests whether this CharSeq ends with the specified suffix
    
    Parameters:
    
    suffix - suffix
    
    Returns:
    
    A boolean
  - endsWith
```
public boolean endsWith(java.lang.String suffix)
```
    Tests whether this CharSeq ends with the specified suffix
    
    Parameters:
    
    suffix - suffix
    
    Returns:
    
    A boolean
  - startsWith
```
public boolean startsWith(CharSeq prefix)
```
    Tests whether this CharSeq starts with the specified prefix
    
    Parameters:
    
    prefix - prefix
    
    Returns:
    
    A boolean
  - charAt
```
public java.lang.Character charAt(int i)
```
    Return the Character at the index i of this CharSeq
    
    Parameters:
    
    i - the index
    
    Returns:
    
    The specified Character
  - trim
```
public CharSeq trim()
```
    Returns a CharSeq whose value is this CharSeq, with any leading and trailing whitespace removed.
    
    Returns:
    
    A new CharSeq with leading and trailing whitespace removed
  - scan
```
public Seq<CharSeq> scan(java.lang.String regex)
```
    Scan through this CharSeq iteratively, generate a Seq of CharSeq with all the matching subStrings.
    
    Parameters:
    
    regex - The regular expression
    
    Returns:
    
    A Seq of CharSeq
  - forEachChar
```
public CharSeq forEachChar(java.util.function.Consumer<java.lang.Character> action)
```
    Performs the given action for each character of the CharSeq.
    
    Parameters:
    
    action - Consumer with single parameter of Character
    
    Returns:
    
    Self
  - forEachChar
```
public CharSeq forEachChar(java.util.function.BiConsumer<java.lang.Character,java.lang.Integer> action)
```
    Performs the given action for each character of the CharSeq, with additional parameter "index" as the second parameter.
    
    Parameters:
    
    action - BiConsumer with parameters of Character and the index
    
    Returns:
    
    Self
  - forEachByte
```
public CharSeq forEachByte(java.util.function.Consumer<java.lang.Byte> action)
```
    Performs the given action for each byte of the CharSeq.
    
    Parameters:
    
    action - Consumer with single parameter of Byte
    
    Returns:
    
    Self
  - forEachByte
```
public CharSeq forEachByte(java.util.function.BiConsumer<java.lang.Byte,java.lang.Integer> action)
```
    Performs the given action for each byte of the CharSeq, with additional parameter "index" as the second parameter.
    
    Parameters:
    
    action - BiConsumer with parameters of Byte and the index
    
    Returns:
    
    Self
  - forEachLine
```
public CharSeq forEachLine(java.util.function.Consumer<CharSeq> action)
```
    Performs the given action for each line of the CharSeq.
    
    Parameters:
    
    action - Consumer with single parameter of CharSeq
    
    Returns:
    
    Self
  - forEachLine
```
public CharSeq forEachLine(java.util.function.BiConsumer<CharSeq,java.lang.Integer> action)
```
    Performs the given action for each line of the CharSeq, with additional parameter "index" as the second parameter.
    
    Parameters:
    
    action - BiConsumer with parameters of CharSeq and the index
    
    Returns:
    
    Self
  - eachLine
```
public Seq<CharSeq> eachLine()
```
    Split the CharSeq by the newline character and return the result as a Seq of CharSeq.
    
    Returns:
    
    A Seq of CharSeq
  - matches
```
public boolean matches(java.lang.String regex)
```
    Tells whether or not this CharSeq matches the given regular expression.
    
    Returns:
    
    A boolean
  - replaceFirst
```
public CharSeq replaceFirst(java.lang.String regex,
                            CharSeq replacement)
```
    Return a new CharSeq by replacing the first substring of this CharSeq that matches the given regular expression with the given CharSeq replacement.
    
    Parameters:
    
    regex - The regular expression
    
    replacement - The replacement CharSeq
    
    Returns:
    
    A new CharSeq
  - replaceFirst
```
public CharSeq replaceFirst(java.lang.String regex,
                            java.lang.String replacement)
```
    Return a new CharSeq by replacing the first substring of this CharSeq that matches the given regular expression with the given String replacement.
    
    Parameters:
    
    regex - The regular expression
    
    replacement - The replacement String
    
    Returns:
    
    A new CharSeq
  - replaceAll
```
public CharSeq replaceAll(java.lang.String regex,
                          CharSeq replacement)
```
    Return a new CharSeq by replacing each substring of this CharSeq that matches the given regular expression with the given CharSeq replacement.
    
    Parameters:
    
    regex - The regular expression
    
    replacement - The replacement CharSeq
    
    Returns:
    
    A new CharSeq
  - replaceAll
```
public CharSeq replaceAll(java.lang.String regex,
                          java.lang.String replacement)
```
    Return a new CharSeq by replacing each substring of this CharSeq that matches the given regular expression with the given String replacement.
    
    Parameters:
    
    regex - The regular expression
    
    replacement - The replacement String
    
    Returns:
    
    A new CharSeq
  - equals
```
public boolean equals(java.lang.Object another)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(CharSeq another)
```
    Compares two CharSeqs lexicographically.
    
    Returns:
    
    the value 0 if the argument CharSeq is equal to this CharSeq; a value less than 0 if this CharSeq is lexicographically less than the CharSeq argument; and a value greater than 0 if this CharSeq is lexicographically greater than the CharSeq argument.
  - compareToIgnoreCase
```
public int compareToIgnoreCase(CharSeq another)
```
    Compares two CharSeqs lexicographically ignore case differences.
    
    Returns:
    
    a negative integer, zero, or a positive integer as the specified String is greater than, equal to, or less than this String, ignoring case considerations.
  - partition
```
public Seq<CharSeq> partition(java.lang.String regex)
```
    Searches pattern (regex) in the CharSeq and returns a Seq of CharSeq consists of the part before it, the first match, and the part after it.
    If no such match is found in this CharSeq, return a Seq of CharSeq consists two empty CharSeqs and the CharSeq itself.
    
    Parameters:
    
    regex - Regular Expression
    
    Returns:
    
    A Seq of CharSeq
  - rPartition
```
public Seq<CharSeq> rPartition(java.lang.String regex)
```
    Searches pattern (regex) in the CharSeq and returns a Seq of CharSeq consists of the part before it, the last match, and the part after it.
    If no such match is found in this CharSeq, return a Seq of CharSeq consists of two empty CharSeqs and the CharSeq itself.
    
    Parameters:
    
    regex - Regular Expression
    
    Returns:
    
    A Seq of CharSeq
  - eachChar
```
public Seq<java.lang.Character> eachChar()
```
    Converts this CharSeq to a new Character Seq.
    
    Returns:
    
    A Seq of Character
  - eachByte
```
public Seq<java.lang.Byte> eachByte()
```
    Encodes this CharSeq into a sequence of bytes using the platform's default charset, storing the result into a new Byte Seq.
    
    Returns:
    
    A Seq of Byte
  - eachCodePoint
```
public Seq<java.lang.Integer> eachCodePoint()
```
    Returns the collection of the Unicode of each character in this CharSeq.
    
    Returns:
    
    the collection of ths Unicode of each character
  - forEachCodePoint
```
public CharSeq forEachCodePoint(java.util.function.Consumer<java.lang.Integer> consumer)
```
    Takes action on the Unicode of each character in this CharSeq.
    Similar to eachCodePoint(), but instead of returning the Unicode collection, it iterates the collection and takes action.
    
    Parameters:
    
    consumer - the action to be taken on the Unicode of each character
    
    Throws:
    
    java.lang.NullPointerException - if consumer is null
  - containsSubSeq
```
public boolean containsSubSeq(java.lang.String seq)
```
    Check whether this CharSeq contains the sub seq, if the given seq is empty, always return true.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null
  - indexOfSubSeq
```
public int indexOfSubSeq(java.lang.String seq)
```
    Return the first index of the given sub seq, or -1 if the given seq is not a sub seq. If the given seq is empty, always return 0.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null
  - lastIndexOfSubSeq
```
public int lastIndexOfSubSeq(java.lang.String seq)
```
    Return the last index of the given sub seq, or -1 if the given seq is not a sub seq. If the given seq is empty, always return 0.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null
  - containsSubSeq
```
public boolean containsSubSeq(CharSeq seq)
```
    Check whether this CharSeq contains the sub seq, if the given seq is empty, always return true.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null
  - indexOfSubSeq
```
public int indexOfSubSeq(CharSeq seq)
```
    Return the first index of the given sub seq, or -1 if the given seq is not a sub seq. If the given seq is empty, always return 0.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null
  - lastIndexOfSubSeq
```
public int lastIndexOfSubSeq(CharSeq seq)
```
    Return the last index of the given sub seq, or -1 if the given seq is not a sub seq. If the given seq is empty, always return 0.
    
    Throws:
    
    java.lang.NullPointerException - if seq is null

Class CharSeq

Method Summary

Methods inherited from class java.lang.Object

Method Detail

subSeq

subSeq

concat

concat

prepend

prepend

length

isEmpty

capitalize

toUpperCase

toLowerCase

split

of

of

reverse

swapcase

endsWith

endsWith

startsWith

charAt

trim

scan

forEachChar

forEachChar

forEachByte

forEachByte

forEachLine

forEachLine

eachLine

matches

replaceFirst

replaceFirst

replaceAll

replaceAll

equals

toString

compareTo

compareToIgnoreCase

partition

rPartition

eachChar

eachByte

eachCodePoint

forEachCodePoint

containsSubSeq

indexOfSubSeq

lastIndexOfSubSeq

containsSubSeq

indexOfSubSeq

lastIndexOfSubSeq