Package io.vavr.collection

Class CharSeq

  • All Implemented Interfaces:
    Foldable<java.lang.Character>, IndexedSeq<java.lang.Character>, Seq<java.lang.Character>, Traversable<java.lang.Character>, Function1<java.lang.Integer,​java.lang.Character>, Iterable<java.lang.Character>, PartialFunction<java.lang.Integer,​java.lang.Character>, Value<java.lang.Character>, java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<CharSeq>, java.lang.Iterable<java.lang.Character>, java.util.function.Function<java.lang.Integer,​java.lang.Character>
    public final class CharSeq
extends java.lang.Object
implements java.lang.CharSequence, IndexedSeq<java.lang.Character>, java.io.Serializable, java.lang.Comparable<CharSeq>
    The CharSeq (read: character sequence) collection essentially is a rich String wrapper having all operations we know from the functional Vavr collections.

    Note:Because CharSeq represents a sequence of primitive characters (i.e. a String), it breaks the Liskov Substitution Principle in the way, that the CharSeq cannot contain null elements. In future version of Java, CharSeq should extend IndexedSeq<char> instead.

    See Also:
    Serialized Form

    • Method Summary

      Modifier and Type Method Description
      CharSeq append​(java.lang.Character element)
      Appends an element to this.
      CharSeq appendAll​(java.lang.Iterable<? extends java.lang.Character> elements)
      Appends all given elements to this.
      java.util.List<java.lang.Character> asJava()
      Creates an immutable List view on top of this Seq, i.e.
      CharSeq asJava​(java.util.function.Consumer<? super java.util.List<java.lang.Character>> action)
      Creates an immutable List view on top of this Seq that is passed to the given action.
      java.util.List<java.lang.Character> asJavaMutable()
      Creates a mutable List view on top of this Seq, i.e.
      CharSeq asJavaMutable​(java.util.function.Consumer<? super java.util.List<java.lang.Character>> action)
      Creates a mutable List view on top of this Seq that is passed to the given action.
      CharSeq capitalize()
      Converts the first character in this CharSeq to upper case using the rules of the default locale.
      CharSeq capitalize​(java.util.Locale locale)
      Converts the first character in this CharSeq to upper case using the rules of the given Locale.
      char charAt​(int index)
      Returns the char value at the specified index.
      int codePointAt​(int index)
      Returns the character (Unicode code point) at the specified index.
      int codePointBefore​(int index)
      Returns the character (Unicode code point) before the specified index.
      int codePointCount​(int beginIndex, int endIndex)
      Returns the number of Unicode code points in the specified text range of this CharSeq.
      <R> IndexedSeq<R> collect​(PartialFunction<? super java.lang.Character,​? extends R> partialFunction)
      Collects all elements that are in the domain of the given partialFunction by mapping the elements to type R.
      static java.util.stream.Collector<java.lang.Character,​java.util.ArrayList<java.lang.Character>,​CharSeq> collector()
      Returns a Collector which may be used in conjunction with Stream.collect(java.util.stream.Collector) to obtain a CharSeq.
      IndexedSeq<CharSeq> combinations()
      Returns the union of all combinations from k = 0 to length().
      IndexedSeq<CharSeq> combinations​(int k)
      Returns the k-combination of this traversable, i.e.
      int compareTo​(CharSeq anotherString)
      Compares two strings lexicographically.
      int compareToIgnoreCase​(CharSeq str)
      Compares two strings lexicographically, ignoring case differences.
      CharSeq concat​(CharSeq str)
      Concatenates the specified string to the end of this string.
      boolean contains​(java.lang.CharSequence s)
      Returns true if and only if this string contains the specified sequence of char values.
      boolean contentEquals​(java.lang.CharSequence cs)
      Compares this string to the specified CharSequence.
      boolean contentEquals​(java.lang.StringBuffer sb)
      Compares this string to the specified StringBuffer.
      Iterator<CharSeq> crossProduct​(int power)
      Calculates the n-ary cartesian power (or cross product or simply product) of this.
      java.lang.Byte decodeByte()
      Decodes this CharSeq into a Byte by calling Byte.decode(String).
      java.lang.Integer decodeInteger()
      Decodes this CharSeq into an Integer by calling Integer.decode(String).
      java.lang.Long decodeLong()
      Decodes this CharSeq into a Long by calling Long.decode(String).
      java.lang.Short decodeShort()
      Decodes this CharSeq into a Short by calling Short.decode(String).
      CharSeq distinct()
      Returns a new version of this which contains no duplicates.
      CharSeq distinctBy​(java.util.Comparator<? super java.lang.Character> comparator)
      Returns a new version of this which contains no duplicates.
      <U> CharSeq distinctBy​(java.util.function.Function<? super java.lang.Character,​? extends U> keyExtractor)
      Returns a new version of this which contains no duplicates.
      CharSeq drop​(int n)
      Drops the first n elements of this or all elements, if this length < n.
      CharSeq dropRight​(int n)
      Drops the last n elements of this or all elements, if this length < n.
      CharSeq dropRightUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Drops elements until the predicate holds for the current element, starting from the end.
      CharSeq dropRightWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Drops elements while the predicate holds for the current element, starting from the end.
      CharSeq dropUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Drops elements until the predicate holds for the current element.
      CharSeq dropWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Drops elements while the predicate holds for the current element.
      static CharSeq empty()  
      boolean endsWith​(CharSeq suffix)
      Tests if this string ends with the specified suffix.
      boolean equals​(java.lang.Object o)
      In Vavr there are four basic classes of collections: Seq (sequential elements) Set (distinct elements) Map (indexed elements) Multimap (indexed collections) Two collection instances of these classes are equal if and only if both collections belong to the same basic collection class (Seq, Set, Map or Multimap) contain the same elements have the same element order, if the collections are of type Seq Two Map/Multimap elements, resp.
      boolean equalsIgnoreCase​(CharSeq anotherString)
      Compares this CharSeq to another CharSeq, ignoring case considerations.
      static CharSeq fill​(int n, java.util.function.Supplier<? extends java.lang.Character> s)
      Returns a CharSeq containing n values supplied by a given Supplier s.
      CharSeq filter​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Returns a new traversable consisting of all elements which satisfy the given predicate.
      CharSeq filterNot​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Returns a new traversable consisting of all elements which do not satisfy the given predicate.
      <U> IndexedSeq<U> flatMap​(java.util.function.Function<? super java.lang.Character,​? extends java.lang.Iterable<? extends U>> mapper)
      FlatMaps this Traversable.
      CharSeq flatMapChars​(CharSeq.CharFunction<? extends java.lang.CharSequence> mapper)  
      java.lang.Character get​(int index)
      Returns the element at the specified index.
      byte[] getBytes()
      Encodes this CharSeq into a sequence of bytes using the platform's default charset, storing the result into a new byte array.
      byte[] getBytes​(java.lang.String charsetName)
      Encodes this CharSeq into a sequence of bytes using the named charset, storing the result into a new byte array.
      byte[] getBytes​(java.nio.charset.Charset charset)
      Encodes this CharSeq into a sequence of bytes using the given charset, storing the result into a new byte array.
      void getChars​(int srcBegin, int srcEnd, char[] dst, int dstBegin)
      Copies characters from this string into the destination character array.
      <C> Map<C,​CharSeq> groupBy​(java.util.function.Function<? super java.lang.Character,​? extends C> classifier)
      Groups this elements by classifying the elements.
      Iterator<CharSeq> grouped​(int size)
      Groups this Traversable into fixed size blocks.
      boolean hasDefiniteSize()
      Checks if this Traversable is known to have a finite size.
      int hashCode()
      Returns the hash code of this collection.
      java.lang.Character head()
      Returns the first element of a non-empty Traversable.
      int indexOf​(int ch)
      Returns the index within this string of the first occurrence of the specified character.
      int indexOf​(int ch, int fromIndex)
      Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.
      int indexOf​(CharSeq str)
      Returns the index within this string of the first occurrence of the specified substring.
      int indexOf​(CharSeq str, int fromIndex)
      Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.
      int indexOf​(java.lang.Character element, int from)
      Returns the index of the first occurrence of the given element after or at some start index or -1 if this does not contain the given element.
      Option<java.lang.Integer> indexOfOption​(CharSeq str)
      Returns the index of the first occurrence of the given element as an Option.
      Option<java.lang.Integer> indexOfOption​(CharSeq str, int fromIndex)
      Returns the index of the first occurrence of the given element as an Option, starting the search at the specified index.
      CharSeq init()
      Dual of Traversable.tail(), returning all elements except the last.
      Option<CharSeq> initOption()
      Dual of Traversable.tailOption(), returning all elements except the last as Option.
      CharSeq insert​(int index, java.lang.Character element)
      Inserts the given element at the specified index.
      CharSeq insertAll​(int index, java.lang.Iterable<? extends java.lang.Character> elements)
      Inserts the given elements at the specified index.
      CharSeq intersperse​(java.lang.Character element)
      Inserts an element between all elements of this Traversable.
      boolean isAsync()
      A CharSeq is computed synchronously.
      boolean isEmpty()
      Checks if this Traversable is empty.
      boolean isLazy()
      A CharSeq is computed eagerly.
      boolean isTraversableAgain()
      Checks if this Traversable can be repeatedly traversed.
      Iterator<java.lang.Character> iterator()
      An iterator by means of head() and tail().
      int lastIndexOf​(int ch)
      Returns the index within this string of the last occurrence of the specified character.
      int lastIndexOf​(int ch, int fromIndex)
      Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.
      int lastIndexOf​(CharSeq str)
      Returns the index within this string of the last occurrence of the specified substring.
      int lastIndexOf​(CharSeq str, int fromIndex)
      Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.
      int lastIndexOf​(java.lang.Character element, int end)
      Returns the index of the last occurrence of the given element before or at a given end index or -1 if this does not contain the given element.
      Option<java.lang.Integer> lastIndexOfOption​(int ch, int fromIndex)
      Returns the index of the last occurrence of the given element as an Option, starting the search at the specified index.
      Option<java.lang.Integer> lastIndexOfOption​(CharSeq str)
      Returns the index of the last occurrence of the given element as an Option.
      Option<java.lang.Integer> lastIndexOfOption​(CharSeq str, int fromIndex)
      Returns the index of the last occurrence of the given element as an Option, starting the search at the specified index.
      CharSeq leftPadTo​(int length, java.lang.Character element)
      A copy of this sequence with an element prepended until a given target length is reached.
      int length()
      Returns the length of this string.
      <U> IndexedSeq<U> map​(java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
      Maps the elements of this Traversable to elements of a new type preserving their order, if any.
      CharSeq mapChars​(CharSeq.CharUnaryOperator mapper)  
      boolean matches​(java.lang.String regex)
      Tells whether or not this string matches the given regular expression.
      java.lang.String mkString()
      Joins the elements of this by concatenating their string representations.
      static CharSeq of​(char character)
      Returns a singleton CharSeq, i.e.
      static CharSeq of​(char... characters)
      Creates a String of the given characters.
      static CharSeq of​(java.lang.CharSequence sequence)
      Creates a String of CharSequence.
      static CharSeq ofAll​(java.lang.Iterable<? extends java.lang.Character> elements)
      Creates a String of the given elements.
      int offsetByCodePoints​(int index, int codePointOffset)
      Returns the index within this CharSeq that is offset from the given index by codePointOffset code points.
      CharSeq orElse​(java.lang.Iterable<? extends java.lang.Character> other)
      Returns this Traversable if it is nonempty, otherwise return the alternative.
      CharSeq orElse​(java.util.function.Supplier<? extends java.lang.Iterable<? extends java.lang.Character>> supplier)
      Returns this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
      CharSeq padTo​(int length, java.lang.Character element)
      A copy of this sequence with an element appended until a given target length is reached.
      boolean parseBoolean()
      Parses this CharSeq as a boolean by calling Boolean.parseBoolean(String).
      byte parseByte()
      Parses this CharSeq as a signed decimal byte by calling Byte.parseByte(String).
      byte parseByte​(int radix)
      Parses this CharSeq as a signed byte in the specified radix by calling Byte.parseByte(String, int).
      double parseDouble()
      Parses this CharSeq as a double by calling Double.parseDouble(String).
      float parseFloat()
      Parses this CharSeq as a float by calling Float.parseFloat(String).
      int parseInt()
      Parses this CharSeq as a signed decimal int by calling Integer.parseInt(String).
      int parseInt​(int radix)
      Parses this CharSeq as a signed int in the specified radix by calling Integer.parseInt(String, int).
      long parseLong()
      Parses this CharSeq as a signed decimal long by calling Long.parseLong(String).
      long parseLong​(int radix)
      Parses this CharSeq as a signed long in the specified radix by calling Long.parseLong(String, int).
      short parseShort()
      Parses this CharSeq as a signed decimal short by calling Short.parseShort(String).
      short parseShort​(int radix)
      Parses this CharSeq as a signed short in the specified radix by calling Short.parseShort(String, int).
      int parseUnsignedInt()
      Parses this CharSeq as a unsigned decimal int by calling Integer.parseUnsignedInt(String).
      int parseUnsignedInt​(int radix)
      Parses this CharSeq as a unsigned int in the specified radix by calling Integer.parseUnsignedInt(String, int).
      long parseUnsignedLong()
      Parses this CharSeq as a unsigned decimal long by calling Long.parseUnsignedLong(String).
      long parseUnsignedLong​(int radix)
      Parses this CharSeq as a unsigned long in the specified radix by calling Long.parseUnsignedLong(String, int).
      Tuple2<CharSeq,​CharSeq> partition​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Creates a partition of this Traversable by splitting this elements in two in distinct traversables according to a predicate.
      CharSeq patch​(int from, java.lang.Iterable<? extends java.lang.Character> that, int replaced)
      Produces a new list where a slice of elements in this list is replaced by another sequence.
      CharSeq peek​(java.util.function.Consumer<? super java.lang.Character> action)
      Performs the given action on the first element if this is an eager implementation.
      IndexedSeq<CharSeq> permutations()
      Computes all unique permutations.
      CharSeq prepend​(java.lang.Character element)
      Prepends an element to this.
      CharSeq prependAll​(java.lang.Iterable<? extends java.lang.Character> elements)
      Prepends all given elements to this.
      static CharSeq range​(char from, char toExclusive)
      Creates a CharSeq starting from character from, extending to character toExclusive - 1.
      static CharSeq rangeBy​(char from, char toExclusive, int step)  
      static CharSeq rangeClosed​(char from, char toInclusive)
      Creates a CharSeq starting from character from, extending to character toInclusive.
      static CharSeq rangeClosedBy​(char from, char toInclusive, int step)
      Creates a CharSeq starting from character from, extending to character toInclusive, with step.
      boolean regionMatches​(boolean ignoreCase, int toffset, CharSeq other, int ooffset, int len)
      Tests if two string regions are equal.
      boolean regionMatches​(int toffset, CharSeq other, int ooffset, int len)
      Tests if two string regions are equal.
      CharSeq reject​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Deprecated.
      CharSeq remove​(java.lang.Character element)
      Removes the first occurrence of the given element.
      CharSeq removeAll​(java.lang.Character element)
      Removes all occurrences of the given element.
      CharSeq removeAll​(java.lang.Iterable<? extends java.lang.Character> elements)
      Removes all occurrences of the given elements.
      CharSeq removeAll​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Deprecated.
      CharSeq removeAt​(int index)
      Removes the element at the specified position in this sequence.
      CharSeq removeFirst​(java.util.function.Predicate<java.lang.Character> predicate)
      Removes the first occurrence that satisfy predicate
      CharSeq removeLast​(java.util.function.Predicate<java.lang.Character> predicate)
      Removes the last occurrence that satisfy predicate
      static CharSeq repeat​(char character, int times)
      Repeats a character times times.
      CharSeq repeat​(int times)
      Repeats this CharSeq times times.
      CharSeq replace​(java.lang.Character currentElement, java.lang.Character newElement)
      Replaces the first occurrence (if exists) of the given currentElement with newElement.
      CharSeq replace​(java.lang.CharSequence target, java.lang.CharSequence replacement)
      Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence.
      CharSeq replaceAll​(java.lang.Character currentElement, java.lang.Character newElement)
      Replaces all occurrences of the given currentElement with newElement.
      CharSeq replaceAll​(java.lang.String regex, java.lang.String replacement)
      Replaces each substring of this string that matches the given regular expression with the given replacement.
      CharSeq replaceFirst​(java.lang.String regex, java.lang.String replacement)
      Replaces the first substring of this string that matches the given regular expression with the given replacement.
      CharSeq retainAll​(java.lang.Iterable<? extends java.lang.Character> elements)
      Keeps all occurrences of the given elements from this.
      CharSeq reverse()
      Reverses the order of elements.
      CharSeq rotateLeft​(int n)
      Circular rotates the elements by the specified distance to the left direction.
      CharSeq rotateRight​(int n)
      Circular rotates the elements by the specified distance to the right direction.
      CharSeq scan​(java.lang.Character zero, java.util.function.BiFunction<? super java.lang.Character,​? super java.lang.Character,​? extends java.lang.Character> operation)
      Computes a prefix scan of the elements of the collection.
      <U> IndexedSeq<U> scanLeft​(U zero, java.util.function.BiFunction<? super U,​? super java.lang.Character,​? extends U> operation)
      Produces a collection containing cumulative results of applying the operator going left to right.
      <U> IndexedSeq<U> scanRight​(U zero, java.util.function.BiFunction<? super java.lang.Character,​? super U,​? extends U> operation)
      Produces a collection containing cumulative results of applying the operator going right to left.
      CharSeq shuffle()
      Randomize the order of the elements in the current sequence.
      CharSeq shuffle​(java.util.Random random)
      Randomize the order of the elements in the current sequence using the given source of randomness.
      CharSeq slice​(int beginIndex, int endIndex)
      Returns a Seq that is a slice of this.
      Iterator<CharSeq> slideBy​(java.util.function.Function<? super java.lang.Character,​?> classifier)
      Slides a non-overlapping window of a variable size over this Traversable.
      Iterator<CharSeq> sliding​(int size)
      Slides a window of a specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).
      Iterator<CharSeq> sliding​(int size, int step)
      Slides a window of a specific size and step size over this Traversable.
      <U> CharSeq sortBy​(java.util.Comparator<? super U> comparator, java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
      Sorts this elements by comparing the elements in a different domain, using the given mapper.
      <U extends java.lang.Comparable<? super U>>
      CharSeq      		 sortBy​(java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
      Sorts this elements by comparing the elements in a different domain, using the given mapper.
      CharSeq sorted()
      Sorts this elements according to their natural order.
      CharSeq sorted​(java.util.Comparator<? super java.lang.Character> comparator)
      Sorts this elements according to the provided Comparator.
      Tuple2<CharSeq,​CharSeq> span​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Returns a tuple where the first element is the longest prefix of elements that satisfy the given predicate and the second element is the remainder.
      Seq<CharSeq> split​(java.lang.String regex)
      Splits this string around matches of the given regular expression.
      Seq<CharSeq> split​(java.lang.String regex, int limit)
      Splits this string around matches of the given regular expression.
      Tuple2<CharSeq,​CharSeq> splitAt​(int n)
      Splits a Seq at the specified index.
      Tuple2<CharSeq,​CharSeq> splitAt​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Splits a sequence at the first element which satisfies the Predicate, e.g.
      Tuple2<CharSeq,​CharSeq> splitAtInclusive​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Splits a sequence at the first element which satisfies the Predicate, e.g.
      boolean startsWith​(CharSeq prefix)
      Tests if this string starts with the specified prefix.
      boolean startsWith​(CharSeq prefix, int toffset)
      Tests if the substring of this string beginning at the specified index starts with the specified prefix.
      boolean startsWith​(java.lang.Iterable<? extends java.lang.Character> that, int offset)
      Tests whether this list contains the given sequence at a given index.
      java.lang.String stringPrefix()
      Returns the name of this Value type, which is used by toString().
      CharSeq subSequence​(int beginIndex)
      Returns a Seq that is a subsequence of this.
      CharSeq subSequence​(int beginIndex, int endIndex)
      Returns a Seq that is a subsequence of this.
      CharSeq substring​(int beginIndex)
      Returns a string that is a substring of this string.
      CharSeq substring​(int beginIndex, int endIndex)
      Returns a string that is a substring of this string.
      static CharSeq tabulate​(int n, java.util.function.Function<? super java.lang.Integer,​? extends java.lang.Character> f)
      Returns a CharSeq containing n values of a given Function f over a range of integer values from 0 to n - 1.
      CharSeq tail()
      Drops the first element of a non-empty Traversable.
      Option<CharSeq> tailOption()
      Drops the first element of a non-empty Traversable and returns an Option.
      CharSeq take​(int n)
      Takes the first n elements of this or all elements, if this length < n.
      CharSeq takeRight​(int n)
      Takes the last n elements of this or all elements, if this length < n.
      CharSeq takeRightUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Takes elements until the predicate holds for the current element, starting from the end.
      CharSeq takeRightWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Takes elements while the predicate holds for the current element, starting from the end.
      CharSeq takeUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Takes elements until the predicate holds for the current element.
      CharSeq takeWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
      Takes elements while the predicate holds for the current element.
      java.lang.Boolean toBoolean()
      Converts this CharSeq to a Boolean by calling Boolean.valueOf(String).
      java.lang.Byte toByte()
      Converts this CharSeq to a Byte by calling Byte.valueOf(String).
      java.lang.Byte toByte​(int radix)
      Converts this CharSeq to a Byte in the specified radix by calling Byte.valueOf(String, int).
      char[] toCharArray()
      Converts this string to a new character array.
      java.lang.Double toDouble()
      Converts this CharSeq to a Double by calling Double.valueOf(String).
      java.lang.Float toFloat()
      Converts this CharSeq to a Float by calling Float.valueOf(String).
      java.lang.Integer toInteger()
      Converts this CharSeq to an Integer by calling Integer.valueOf(String).
      java.lang.Integer toInteger​(int radix)
      Converts this CharSeq to an Integer in the specified radix by calling Integer.valueOf(String, int).
      java.lang.Character[] toJavaArray()
      Converts this to a Java array with component type Object
      java.lang.Long toLong()
      Converts this CharSeq to a Long by calling Long.valueOf(String).
      java.lang.Long toLong​(int radix)
      Converts this CharSeq to a Long in the specified radix by calling Long.valueOf(String, int).
      CharSeq toLowerCase()
      Converts all of the characters in this CharSeq to lower case using the rules of the default locale.
      CharSeq toLowerCase​(java.util.Locale locale)
      Converts all of the characters in this CharSeq to lower case using the rules of the given Locale.
      java.lang.Short toShort()
      Converts this CharSeq to a Short by calling Short.valueOf(String).
      java.lang.Short toShort​(int radix)
      Converts this CharSeq to a Short in the specified radix by calling Short.valueOf(String, int).
      java.lang.String toString()
      Returns a string containing the characters in this sequence in the same order as this sequence.
      CharSeq toUpperCase()
      Converts all of the characters in this CharSeq to upper case using the rules of the default locale.
      CharSeq toUpperCase​(java.util.Locale locale)
      Converts all of the characters in this CharSeq to upper case using the rules of the given Locale.
      <U> U transform​(java.util.function.Function<? super CharSeq,​? extends U> f)
      Transforms this CharSeq.
      CharSeq trim()
      Returns a string whose value is this string, with any leading and trailing whitespace removed.
      static CharSeq unfold​(java.lang.Character seed, java.util.function.Function<? super java.lang.Character,​Option<Tuple2<? extends java.lang.Character,​? extends java.lang.Character>>> f)
      Creates a CharSeq from a seed value and a function.
      static <T> CharSeq unfoldLeft​(T seed, java.util.function.Function<? super T,​Option<Tuple2<? extends T,​? extends java.lang.Character>>> f)
      Creates a CharSeq from a seed value and a function.
      static <T> CharSeq unfoldRight​(T seed, java.util.function.Function<? super T,​Option<Tuple2<? extends java.lang.Character,​? extends T>>> f)
      Creates a CharSeq from a seed value and a function.
      <T1,​T2>
      Tuple2<IndexedSeq<T1>,​IndexedSeq<T2>>      		 unzip​(java.util.function.Function<? super java.lang.Character,​Tuple2<? extends T1,​? extends T2>> unzipper)
      Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.
      <T1,​T2,​T3>
      Tuple3<IndexedSeq<T1>,​IndexedSeq<T2>,​IndexedSeq<T3>>      		 unzip3​(java.util.function.Function<? super java.lang.Character,​Tuple3<? extends T1,​? extends T2,​? extends T3>> unzipper)
      Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.
      CharSeq update​(int index, java.lang.Character element)
      Updates the given element at the specified index.
      CharSeq update​(int index, java.util.function.Function<? super java.lang.Character,​? extends java.lang.Character> updater)
      Updates the given element at the specified index using the specified function.
      <U> IndexedSeq<Tuple2<java.lang.Character,​U>> zip​(java.lang.Iterable<? extends U> that)
      Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.
      <U> IndexedSeq<Tuple2<java.lang.Character,​U>> zipAll​(java.lang.Iterable<? extends U> that, java.lang.Character thisElem, U thatElem)
      Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.
      <U,​R>
      IndexedSeq<R>      		 zipWith​(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super java.lang.Character,​? super U,​? extends R> mapper)
      Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
      IndexedSeq<Tuple2<java.lang.Character,​java.lang.Integer>> zipWithIndex()
      Zips this traversable with its indices.
      <U> IndexedSeq<U> zipWithIndex​(java.util.function.BiFunction<? super java.lang.Character,​? super java.lang.Integer,​? extends U> mapper)
      Returns a traversable formed from this traversable and another Iterable collection by mapping elements.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.CharSequence

        chars, codePoints

      • Methods inherited from interface io.vavr.Iterable

        to

    • Method Detail

      • empty

        public static CharSeq empty()

      • collector

        public static java.util.stream.Collector<java.lang.Character,​java.util.ArrayList<java.lang.Character>,​CharSeq> collector()
        Returns a Collector which may be used in conjunction with Stream.collect(java.util.stream.Collector) to obtain a CharSeq.
        Returns:
        A CharSeq Collector.

      • of

        public static CharSeq of​(java.lang.CharSequence sequence)
        Creates a String of CharSequence.
        Parameters:
        sequence - CharSequence instance.
        Returns:
        A new CharSeq

      • of

        public static CharSeq of​(char character)
        Returns a singleton CharSeq, i.e. a CharSeq of one character.
        Parameters:
        character - A character.
        Returns:
        A new CharSeq instance containing the given element

      • of

        public static CharSeq of​(char... characters)
        Creates a String of the given characters.
        Parameters:
        characters - Zero or more characters.
        Returns:
        A string containing the given characters in the same order.
        Throws:
        java.lang.NullPointerException - if elements is null

      • ofAll

        public static CharSeq ofAll​(java.lang.Iterable<? extends java.lang.Character> elements)
        Creates a String of the given elements.

        The resulting string has the same iteration order as the given iterable of elements if the iteration order of the elements is stable.

        Parameters:
        elements - An Iterable of elements.
        Returns:
        A string containing the given elements in the same order.
        Throws:
        java.lang.NullPointerException - if elements is null or elements contains null

      • tabulate

        public static CharSeq tabulate​(int n,
                               java.util.function.Function<? super java.lang.Integer,​? extends java.lang.Character> f)
        Returns a CharSeq containing n values of a given Function f over a range of integer values from 0 to n - 1.
        Parameters:
        n - The number of elements in the CharSeq
        f - The Function computing element values
        Returns:
        A CharSeq consisting of elements f(0),f(1), ..., f(n - 1)
        Throws:
        java.lang.NullPointerException - if f is null

      • fill

        public static CharSeq fill​(int n,
                           java.util.function.Supplier<? extends java.lang.Character> s)
        Returns a CharSeq containing n values supplied by a given Supplier s.
        Parameters:
        n - The number of elements in the CharSeq
        s - The Supplier computing element values
        Returns:
        A CharSeq of size n, where each element contains the result supplied by s.
        Throws:
        java.lang.NullPointerException - if s is null

      • range

        public static CharSeq range​(char from,
                            char toExclusive)
        Creates a CharSeq starting from character from, extending to character toExclusive - 1.

        Examples: 

         
 CharSeq.range('a', 'c')  // = "ab"
 CharSeq.range('c', 'a')  // = ""
        Parameters:
        from - the first character
        toExclusive - the successor of the last character
        Returns:
        a range of characters as specified or the empty range if from >= toExclusive

      • rangeBy

        public static CharSeq rangeBy​(char from,
                              char toExclusive,
                              int step)

      • rangeClosed

        public static CharSeq rangeClosed​(char from,
                                  char toInclusive)
        Creates a CharSeq starting from character from, extending to character toInclusive.

        Examples: 

         
 CharSeq.rangeClosed('a', 'c')  // = "abc"
 CharSeq.rangeClosed('c', 'a')  // = ""
        Parameters:
        from - the first character
        toInclusive - the last character
        Returns:
        a range of characters as specified or the empty range if from > toInclusive

      • rangeClosedBy

        public static CharSeq rangeClosedBy​(char from,
                                    char toInclusive,
                                    int step)
        Creates a CharSeq starting from character from, extending to character toInclusive, with step.

        Examples: 

         
 CharSeq.rangeClosedBy('a', 'c', 1)  // = ('a', 'b', 'c')
 CharSeq.rangeClosedBy('a', 'd', 2)  // = ('a', 'c')
 CharSeq.rangeClosedBy('d', 'a', -2) // = ('d', 'b')
 CharSeq.rangeClosedBy('d', 'a', 2)  // = ()
        Parameters:
        from - the first character
        toInclusive - the last character
        step - the step
        Returns:
        a range of characters as specified or the empty range if step * (from - toInclusive) > 0.
        Throws:
        java.lang.IllegalArgumentException - if step is zero

      • unfoldRight

        public static <T> CharSeq unfoldRight​(T seed,
                                      java.util.function.Function<? super T,​Option<Tuple2<? extends java.lang.Character,​? extends T>>> f)
        Creates a CharSeq from a seed value and a function. The function takes the seed at first. The function should return None when it's done generating the CharSeq, otherwise Some Tuple of the element for the next call and the value to add to the resulting CharSeq.

        Example: 

         
 CharSeq.unfoldRight('j', x -> x == 'a'
             ? Option.none()
             : Option.of(new Tuple2<>(new Character(x), (char)(x-1))));
 // CharSeq.of("jihgfedcb"))
        Type Parameters:
        T - type of seeds
        Parameters:
        seed - the start value for the iteration
        f - the function to get the next step of the iteration
        Returns:
        a CharSeq with the values built up by the iteration
        Throws:
        java.lang.NullPointerException - if f is null

      • unfoldLeft

        public static <T> CharSeq unfoldLeft​(T seed,
                                     java.util.function.Function<? super T,​Option<Tuple2<? extends T,​? extends java.lang.Character>>> f)
        Creates a CharSeq from a seed value and a function. The function takes the seed at first. The function should return None when it's done generating the CharSeq, otherwise Some Tuple of the value to add to the resulting CharSeq and the element for the next call.

        Example: 

         
 CharSeq.unfoldLeft('j', x -> x == 'a'
             ? Option.none()
             : Option.of(new Tuple2<>((char)(x-1), new Character(x))));
 // CharSeq.of("bcdefghij"))
        Type Parameters:
        T - type of seeds
        Parameters:
        seed - the start value for the iteration
        f - the function to get the next step of the iteration
        Returns:
        a CharSeq with the values built up by the iteration
        Throws:
        java.lang.NullPointerException - if f is null

      • unfold

        public static CharSeq unfold​(java.lang.Character seed,
                             java.util.function.Function<? super java.lang.Character,​Option<Tuple2<? extends java.lang.Character,​? extends java.lang.Character>>> f)
        Creates a CharSeq from a seed value and a function. The function takes the seed at first. The function should return None when it's done generating the CharSeq, otherwise Some Tuple of the value to add to the resulting CharSeq and the element for the next call.

        Example: 

         
 CharSeq.unfold('j', x -> x == 'a'
                ? Option.none()
                : Option.of(new Tuple2<>((char)(x-1), new Character(x))));
 // CharSeq.of("bcdefghij"))
        Parameters:
        seed - the start value for the iteration
        f - the function to get the next step of the iteration
        Returns:
        a CharSeq with the values built up by the iteration
        Throws:
        java.lang.NullPointerException - if f is null

      • repeat

        public static CharSeq repeat​(char character,
                             int times)
        Repeats a character times times.
        Parameters:
        character - A character
        times - Repetition count
        Returns:
        A CharSeq representing character * times

      • repeat

        public CharSeq repeat​(int times)
        Repeats this CharSeq times times.

        Example: CharSeq.of("ja").repeat(13) = "jajajajajajajajajajajajaja"

        Parameters:
        times - Repetition count
        Returns:
        A CharSeq representing this * times

      • append

        public CharSeq append​(java.lang.Character element)
        Description copied from interface: Seq
        Appends an element to this.
        Specified by:
        append in interface IndexedSeq<java.lang.Character>
        Specified by:
        append in interface Seq<java.lang.Character>
        Parameters:
        element - An element
        Returns:
        A new Seq containing the given element appended to this elements

      • appendAll

        public CharSeq appendAll​(java.lang.Iterable<? extends java.lang.Character> elements)
        Description copied from interface: Seq
        Appends all given elements to this.
        Specified by:
        appendAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        appendAll in interface Seq<java.lang.Character>
        Parameters:
        elements - An Iterable of elements
        Returns:
        A new Seq containing the given elements appended to this elements

      • asJava

        @GwtIncompatible
public java.util.List<java.lang.Character> asJava()
        Description copied from interface: Seq
        Creates an immutable List view on top of this Seq, i.e. calling mutators will result in UnsupportedOperationException at runtime.

        The difference to conversion methods toJava*() is that

        • A view is created in O(1) (constant time) whereas conversion takes O(n) (linear time), with n = collection size.
        • The operations on a view have the same performance characteristics than the underlying persistent Vavr collection whereas the performance characteristics of a converted collection are those of the Java standard collections.
        Please note that our immutable java.util.List view throws UnsupportedOperationException before checking method arguments. Java does handle this case inconsistently.
        Specified by:
        asJava in interface Seq<java.lang.Character>
        Returns:
        A new immutable Collection view on this Traversable.

      • asJava

        @GwtIncompatible
public CharSeq asJava​(java.util.function.Consumer<? super java.util.List<java.lang.Character>> action)
        Description copied from interface: Seq
        Creates an immutable List view on top of this Seq that is passed to the given action.
        Specified by:
        asJava in interface IndexedSeq<java.lang.Character>
        Specified by:
        asJava in interface Seq<java.lang.Character>
        Parameters:
        action - A side-effecting unit of work that operates on an immutable java.util.List view.
        Returns:
        this instance
        See Also:
        Seq.asJava()

      • asJavaMutable

        @GwtIncompatible
public java.util.List<java.lang.Character> asJavaMutable()
        Description copied from interface: Seq
        Creates a mutable List view on top of this Seq, i.e. all mutator methods of the List are implemented.
        Specified by:
        asJavaMutable in interface Seq<java.lang.Character>
        Returns:
        A new mutable Collection view on this Traversable.
        See Also:
        Seq.asJava()

      • asJavaMutable

        @GwtIncompatible
public CharSeq asJavaMutable​(java.util.function.Consumer<? super java.util.List<java.lang.Character>> action)
        Description copied from interface: Seq
        Creates a mutable List view on top of this Seq that is passed to the given action.
        Specified by:
        asJavaMutable in interface IndexedSeq<java.lang.Character>
        Specified by:
        asJavaMutable in interface Seq<java.lang.Character>
        Parameters:
        action - A side-effecting unit of work that operates on a mutable java.util.List view.
        Returns:
        this instance, if only read operations are performed on the java.util.List view or a new instance of this type, if write operations are performed on the java.util.List view.
        See Also:
        Seq.asJavaMutable()

      • collect

        public <R> IndexedSeq<R> collect​(PartialFunction<? super java.lang.Character,​? extends R> partialFunction)
        Description copied from interface: Traversable
        Collects all elements that are in the domain of the given partialFunction by mapping the elements to type R.

        More specifically, for each of this elements in iteration order first it is checked 

        
 partialFunction.isDefinedAt(element)
        If the elements makes it through that filter, the mapped instance is added to the result collection 
        
 R newElement = partialFunction.apply(element)
        Note:If this Traversable is ordered (i.e. extends Ordered, the caller of collect has to ensure that the elements are comparable (i.e. extend Comparable).
        Specified by:
        collect in interface IndexedSeq<java.lang.Character>
        Specified by:
        collect in interface Seq<java.lang.Character>
        Specified by:
        collect in interface Traversable<java.lang.Character>
        Type Parameters:
        R - The new element type
        Parameters:
        partialFunction - A function that is not necessarily defined of all elements of this traversable.
        Returns:
        A new Traversable instance containing elements of type R

      • combinations

        public IndexedSeq<CharSeq> combinations()
        Description copied from interface: Seq
        Returns the union of all combinations from k = 0 to length().

        Examples: 

         
 [].combinations() = [[]]

 [1,2,3].combinations() = [
   [],                  // k = 0
   [1], [2], [3],       // k = 1
   [1,2], [1,3], [2,3], // k = 2
   [1,2,3]              // k = 3
 ]
        Specified by:
        combinations in interface IndexedSeq<java.lang.Character>
        Specified by:
        combinations in interface Seq<java.lang.Character>
        Returns:
        the combinations of this

      • combinations

        public IndexedSeq<CharSeq> combinations​(int k)
        Description copied from interface: Seq
        Returns the k-combination of this traversable, i.e. all subset of this of k distinct elements.
        Specified by:
        combinations in interface IndexedSeq<java.lang.Character>
        Specified by:
        combinations in interface Seq<java.lang.Character>
        Parameters:
        k - Size of subsets
        Returns:
        the k-combination of this elements
        See Also:
        Combination

      • crossProduct

        public Iterator<CharSeq> crossProduct​(int power)
        Description copied from interface: Seq
        Calculates the n-ary cartesian power (or cross product or simply product) of this.

        Example: 

         
 // = ((A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z))
 CharSeq.rangeClosed('A', 'Z').crossProduct(2);

        Cartesian power of negative value will return empty iterator.

        Example: 

         
 // = ()
 CharSeq.rangeClosed('A', 'Z').crossProduct(-1);
        Specified by:
        crossProduct in interface IndexedSeq<java.lang.Character>
        Specified by:
        crossProduct in interface Seq<java.lang.Character>
        Parameters:
        power - the number of cartesian multiplications
        Returns:
        A new Iterator representing the n-ary cartesian power of this

      • distinct

        public CharSeq distinct()
        Description copied from interface: Traversable
        Returns a new version of this which contains no duplicates. Elements are compared using equals.
        Specified by:
        distinct in interface IndexedSeq<java.lang.Character>
        Specified by:
        distinct in interface Seq<java.lang.Character>
        Specified by:
        distinct in interface Traversable<java.lang.Character>
        Returns:
        a new Traversable containing this elements without duplicates

      • distinctBy

        public CharSeq distinctBy​(java.util.Comparator<? super java.lang.Character> comparator)
        Description copied from interface: Traversable
        Returns a new version of this which contains no duplicates. Elements are compared using the given comparator.
        Specified by:
        distinctBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        distinctBy in interface Seq<java.lang.Character>
        Specified by:
        distinctBy in interface Traversable<java.lang.Character>
        Parameters:
        comparator - A comparator
        Returns:
        a new Traversable containing this elements without duplicates

      • distinctBy

        public <U> CharSeq distinctBy​(java.util.function.Function<? super java.lang.Character,​? extends U> keyExtractor)
        Description copied from interface: Traversable
        Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared using equals.

        The elements of the result are determined in the order of their occurrence - first match wins.

        Specified by:
        distinctBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        distinctBy in interface Seq<java.lang.Character>
        Specified by:
        distinctBy in interface Traversable<java.lang.Character>
        Type Parameters:
        U - key type
        Parameters:
        keyExtractor - A key extractor
        Returns:
        a new Traversable containing this elements without duplicates

      • drop

        public CharSeq drop​(int n)
        Description copied from interface: Traversable
        Drops the first n elements of this or all elements, if this length < n.
        Specified by:
        drop in interface IndexedSeq<java.lang.Character>
        Specified by:
        drop in interface Seq<java.lang.Character>
        Specified by:
        drop in interface Traversable<java.lang.Character>
        Parameters:
        n - The number of elements to drop.
        Returns:
        a new instance consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.

      • dropUntil

        public CharSeq dropUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Drops elements until the predicate holds for the current element.
        Specified by:
        dropUntil in interface IndexedSeq<java.lang.Character>
        Specified by:
        dropUntil in interface Seq<java.lang.Character>
        Specified by:
        dropUntil in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements.
        Returns:
        a new instance consisting of all elements starting from the first one which does satisfy the given predicate.

      • dropWhile

        public CharSeq dropWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Drops elements while the predicate holds for the current element.

        Note: This is essentially the same as dropUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

        Specified by:
        dropWhile in interface IndexedSeq<java.lang.Character>
        Specified by:
        dropWhile in interface Seq<java.lang.Character>
        Specified by:
        dropWhile in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements.
        Returns:
        a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.

      • dropRight

        public CharSeq dropRight​(int n)
        Description copied from interface: Traversable
        Drops the last n elements of this or all elements, if this length < n.
        Specified by:
        dropRight in interface IndexedSeq<java.lang.Character>
        Specified by:
        dropRight in interface Seq<java.lang.Character>
        Specified by:
        dropRight in interface Traversable<java.lang.Character>
        Parameters:
        n - The number of elements to drop.
        Returns:
        a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.

      • dropRightWhile

        public CharSeq dropRightWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Drops elements while the predicate holds for the current element, starting from the end.

        Note: This is essentially the same as dropRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

        Specified by:
        dropRightWhile in interface IndexedSeq<java.lang.Character>
        Specified by:
        dropRightWhile in interface Seq<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements, starting from the end.
        Returns:
        a new instance consisting of all elements until and including the last one which does not satisfy the given predicate.

      • dropRightUntil

        public CharSeq dropRightUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Drops elements until the predicate holds for the current element, starting from the end.
        Specified by:
        dropRightUntil in interface IndexedSeq<java.lang.Character>
        Specified by:
        dropRightUntil in interface Seq<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements, starting from the end.
        Returns:
        a new instance consisting of all elements until and including the last one which does satisfy the given predicate.

      • filter

        public CharSeq filter​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Returns a new traversable consisting of all elements which satisfy the given predicate.
        Specified by:
        filter in interface IndexedSeq<java.lang.Character>
        Specified by:
        filter in interface Seq<java.lang.Character>
        Specified by:
        filter in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable

      • filterNot

        public CharSeq filterNot​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Returns a new traversable consisting of all elements which do not satisfy the given predicate.

        The default implementation is equivalent to 

        filter(predicate.negate()
        Specified by:
        filterNot in interface IndexedSeq<java.lang.Character>
        Specified by:
        filterNot in interface Seq<java.lang.Character>
        Specified by:
        filterNot in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable

      • reject

        @Deprecated
public CharSeq reject​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Deprecated.
        Description copied from interface: Traversable
        Returns a new traversable consisting of all elements which do not satisfy the given predicate.

        The default implementation is equivalent to 

        filter(predicate.negate()
        Specified by:
        reject in interface IndexedSeq<java.lang.Character>
        Specified by:
        reject in interface Seq<java.lang.Character>
        Specified by:
        reject in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable

      • flatMap

        public <U> IndexedSeq<U> flatMap​(java.util.function.Function<? super java.lang.Character,​? extends java.lang.Iterable<? extends U>> mapper)
        Description copied from interface: Traversable
        FlatMaps this Traversable.
        Specified by:
        flatMap in interface IndexedSeq<java.lang.Character>
        Specified by:
        flatMap in interface Seq<java.lang.Character>
        Specified by:
        flatMap in interface Traversable<java.lang.Character>
        Type Parameters:
        U - The resulting component type.
        Parameters:
        mapper - A mapper
        Returns:
        A new Traversable instance.

      • groupBy

        public <C> Map<C,​CharSeq> groupBy​(java.util.function.Function<? super java.lang.Character,​? extends C> classifier)
        Description copied from interface: Traversable
        Groups this elements by classifying the elements.
        Specified by:
        groupBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        groupBy in interface Seq<java.lang.Character>
        Specified by:
        groupBy in interface Traversable<java.lang.Character>
        Type Parameters:
        C - classified class type
        Parameters:
        classifier - A function which classifies elements into classes
        Returns:
        A Map containing the grouped elements
        See Also:
        Traversable.arrangeBy(Function)

      • grouped

        public Iterator<CharSeq> grouped​(int size)
        Description copied from interface: Traversable
        Groups this Traversable into fixed size blocks.

        Let length be the length of this Iterable. Then grouped is defined as follows:

        • If this.isEmpty(), the resulting Iterator is empty.
        • If size <= length, the resulting Iterator will contain length / size blocks of size size and maybe a non-empty block of size length % size, if there are remaining elements.
        • If size > length, the resulting Iterator will contain one block of size length.
        Examples: 
         
 [].grouped(1) = []
 [].grouped(0) throws
 [].grouped(-1) throws
 [1,2,3,4].grouped(2) = [[1,2],[3,4]]
 [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
 [1,2,3,4].grouped(5) = [[1,2,3,4]]
        Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e. grouped(size) is the same as sliding(size, size).
        Specified by:
        grouped in interface IndexedSeq<java.lang.Character>
        Specified by:
        grouped in interface Seq<java.lang.Character>
        Specified by:
        grouped in interface Traversable<java.lang.Character>
        Parameters:
        size - a positive block size
        Returns:
        A new Iterator of grouped blocks of the given size

      • hasDefiniteSize

        public boolean hasDefiniteSize()
        Description copied from interface: Traversable
        Checks if this Traversable is known to have a finite size.

        This method should be implemented by classes only, i.e. not by interfaces.

        Specified by:
        hasDefiniteSize in interface Traversable<java.lang.Character>
        Returns:
        true, if this Traversable is known to have a finite size, false otherwise.

      • init

        public CharSeq init()
        Description copied from interface: Traversable
        Dual of Traversable.tail(), returning all elements except the last.
        Specified by:
        init in interface IndexedSeq<java.lang.Character>
        Specified by:
        init in interface Seq<java.lang.Character>
        Specified by:
        init in interface Traversable<java.lang.Character>
        Returns:
        a new instance containing all elements except the last.

      • insert

        public CharSeq insert​(int index,
                      java.lang.Character element)
        Description copied from interface: Seq
        Inserts the given element at the specified index.
        Specified by:
        insert in interface IndexedSeq<java.lang.Character>
        Specified by:
        insert in interface Seq<java.lang.Character>
        Parameters:
        index - an index
        element - an element
        Returns:
        a new Seq, where the given element is inserted into this at the given index

      • insertAll

        public CharSeq insertAll​(int index,
                         java.lang.Iterable<? extends java.lang.Character> elements)
        Description copied from interface: Seq
        Inserts the given elements at the specified index.
        Specified by:
        insertAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        insertAll in interface Seq<java.lang.Character>
        Parameters:
        index - an index
        elements - An Iterable of elements
        Returns:
        a new Seq, where the given elements are inserted into this at the given index

      • iterator

        public Iterator<java.lang.Character> iterator()
        Description copied from interface: Traversable
        An iterator by means of head() and tail(). Subclasses may want to override this method.
        Specified by:
        iterator in interface Iterable<java.lang.Character>
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.Character>
        Specified by:
        iterator in interface Traversable<java.lang.Character>
        Specified by:
        iterator in interface Value<java.lang.Character>
        Returns:
        A new Iterator of this Traversable elements.

      • intersperse

        public CharSeq intersperse​(java.lang.Character element)
        Description copied from interface: Seq
        Inserts an element between all elements of this Traversable.
        Specified by:
        intersperse in interface IndexedSeq<java.lang.Character>
        Specified by:
        intersperse in interface Seq<java.lang.Character>
        Parameters:
        element - An element.
        Returns:
        an interspersed version of this

      • map

        public <U> IndexedSeq<U> map​(java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
        Description copied from interface: Traversable
        Maps the elements of this Traversable to elements of a new type preserving their order, if any.
        Specified by:
        map in interface IndexedSeq<java.lang.Character>
        Specified by:
        map in interface Seq<java.lang.Character>
        Specified by:
        map in interface Traversable<java.lang.Character>
        Specified by:
        map in interface Value<java.lang.Character>
        Type Parameters:
        U - Component type of the target Traversable
        Parameters:
        mapper - A mapper.
        Returns:
        a mapped Traversable

      • mkString

        public java.lang.String mkString()
        Description copied from interface: Traversable
        Joins the elements of this by concatenating their string representations.

        This has the same effect as calling mkString("", "", "").

        Specified by:
        mkString in interface Traversable<java.lang.Character>
        Returns:
        a new String

      • padTo

        public CharSeq padTo​(int length,
                     java.lang.Character element)
        Description copied from interface: Seq
        A copy of this sequence with an element appended until a given target length is reached.

        Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.

        Specified by:
        padTo in interface IndexedSeq<java.lang.Character>
        Specified by:
        padTo in interface Seq<java.lang.Character>
        Parameters:
        length - the target length
        element - the padding element
        Returns:
        a new sequence consisting of all elements of this sequence followed by the minimal number of occurrences of element so that the resulting sequence has a length of at least length.

      • leftPadTo

        public CharSeq leftPadTo​(int length,
                         java.lang.Character element)
        Description copied from interface: Seq
        A copy of this sequence with an element prepended until a given target length is reached.

        Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.

        Specified by:
        leftPadTo in interface Seq<java.lang.Character>
        Parameters:
        length - the target length
        element - the padding element
        Returns:
        a new sequence consisting of all elements of this sequence prepended by the minimal number of occurrences of element so that the resulting sequence has a length of at least length.

      • orElse

        public CharSeq orElse​(java.lang.Iterable<? extends java.lang.Character> other)
        Description copied from interface: Traversable
        Returns this Traversable if it is nonempty, otherwise return the alternative.
        Specified by:
        orElse in interface IndexedSeq<java.lang.Character>
        Specified by:
        orElse in interface Seq<java.lang.Character>
        Specified by:
        orElse in interface Traversable<java.lang.Character>
        Parameters:
        other - An alternative Traversable
        Returns:
        this Traversable if it is nonempty, otherwise return the alternative.

      • orElse

        public CharSeq orElse​(java.util.function.Supplier<? extends java.lang.Iterable<? extends java.lang.Character>> supplier)
        Description copied from interface: Traversable
        Returns this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
        Specified by:
        orElse in interface IndexedSeq<java.lang.Character>
        Specified by:
        orElse in interface Seq<java.lang.Character>
        Specified by:
        orElse in interface Traversable<java.lang.Character>
        Parameters:
        supplier - An alternative Traversable supplier
        Returns:
        this Traversable if it is nonempty, otherwise return the result of evaluating supplier.

      • patch

        public CharSeq patch​(int from,
                     java.lang.Iterable<? extends java.lang.Character> that,
                     int replaced)
        Description copied from interface: Seq
        Produces a new list where a slice of elements in this list is replaced by another sequence.
        Specified by:
        patch in interface IndexedSeq<java.lang.Character>
        Specified by:
        patch in interface Seq<java.lang.Character>
        Parameters:
        from - the index of the first replaced element
        that - sequence for replacement
        replaced - the number of elements to drop in the original list
        Returns:
        a new sequence.

      • partition

        public Tuple2<CharSeq,​CharSeq> partition​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Creates a partition of this Traversable by splitting this elements in two in distinct traversables according to a predicate.
        Specified by:
        partition in interface IndexedSeq<java.lang.Character>
        Specified by:
        partition in interface Seq<java.lang.Character>
        Specified by:
        partition in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A predicate which classifies an element if it is in the first or the second traversable.
        Returns:
        A disjoint union of two traversables. The first Traversable contains all elements that satisfy the given predicate, the second Traversable contains all elements that don't. The original order of elements is preserved.

      • peek

        public CharSeq peek​(java.util.function.Consumer<? super java.lang.Character> action)
        Description copied from interface: Value
        Performs the given action on the first element if this is an eager implementation. Performs the given action on all elements (the first immediately, successive deferred), if this is a lazy implementation.
        Specified by:
        peek in interface IndexedSeq<java.lang.Character>
        Specified by:
        peek in interface Seq<java.lang.Character>
        Specified by:
        peek in interface Traversable<java.lang.Character>
        Specified by:
        peek in interface Value<java.lang.Character>
        Parameters:
        action - The action that will be performed on the element(s).
        Returns:
        this instance

      • permutations

        public IndexedSeq<CharSeq> permutations()
        Description copied from interface: Seq
        Computes all unique permutations.

        Example: 

         
 [].permutations() = []

 [1,2,3].permutations() = [
   [1,2,3],
   [1,3,2],
   [2,1,3],
   [2,3,1],
   [3,1,2],
   [3,2,1]
 ]
        Specified by:
        permutations in interface IndexedSeq<java.lang.Character>
        Specified by:
        permutations in interface Seq<java.lang.Character>
        Returns:
        this unique permutations

      • prepend

        public CharSeq prepend​(java.lang.Character element)
        Description copied from interface: Seq
        Prepends an element to this.
        Specified by:
        prepend in interface IndexedSeq<java.lang.Character>
        Specified by:
        prepend in interface Seq<java.lang.Character>
        Parameters:
        element - An element
        Returns:
        A new Seq containing the given element prepended to this elements

      • prependAll

        public CharSeq prependAll​(java.lang.Iterable<? extends java.lang.Character> elements)
        Description copied from interface: Seq
        Prepends all given elements to this.
        Specified by:
        prependAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        prependAll in interface Seq<java.lang.Character>
        Parameters:
        elements - An Iterable of elements
        Returns:
        A new Seq containing the given elements prepended to this elements

      • remove

        public CharSeq remove​(java.lang.Character element)
        Description copied from interface: Seq
        Removes the first occurrence of the given element.
        Specified by:
        remove in interface IndexedSeq<java.lang.Character>
        Specified by:
        remove in interface Seq<java.lang.Character>
        Parameters:
        element - An element to be removed from this Seq.
        Returns:
        a Seq containing all elements of this without the first occurrence of the given element.

      • removeFirst

        public CharSeq removeFirst​(java.util.function.Predicate<java.lang.Character> predicate)
        Description copied from interface: Seq
        Removes the first occurrence that satisfy predicate
        Specified by:
        removeFirst in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeFirst in interface Seq<java.lang.Character>
        Parameters:
        predicate - an predicate
        Returns:
        a new Seq

      • removeLast

        public CharSeq removeLast​(java.util.function.Predicate<java.lang.Character> predicate)
        Description copied from interface: Seq
        Removes the last occurrence that satisfy predicate
        Specified by:
        removeLast in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeLast in interface Seq<java.lang.Character>
        Parameters:
        predicate - an predicate
        Returns:
        a new Seq

      • removeAt

        public CharSeq removeAt​(int index)
        Description copied from interface: Seq
        Removes the element at the specified position in this sequence. Shifts any subsequent elements to the left (subtracts one from their indices).
        Specified by:
        removeAt in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeAt in interface Seq<java.lang.Character>
        Parameters:
        index - position of element to remove
        Returns:
        a sequence containing all elements of this without the element at the specified position.

      • removeAll

        public CharSeq removeAll​(java.lang.Character element)
        Description copied from interface: Seq
        Removes all occurrences of the given element.
        Specified by:
        removeAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeAll in interface Seq<java.lang.Character>
        Parameters:
        element - An element to be removed from this Seq.
        Returns:
        a Seq containing all elements of this but not the given element.

      • removeAll

        public CharSeq removeAll​(java.lang.Iterable<? extends java.lang.Character> elements)
        Description copied from interface: Seq
        Removes all occurrences of the given elements.
        Specified by:
        removeAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeAll in interface Seq<java.lang.Character>
        Parameters:
        elements - Elements to be removed from this Seq.
        Returns:
        a Seq containing all elements of this but none of the given elements.

      • removeAll

        @Deprecated
public CharSeq removeAll​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Deprecated.
        Description copied from interface: Seq
        Returns a new Seq consisting of all elements which do not satisfy the given predicate.
        Specified by:
        removeAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        removeAll in interface Seq<java.lang.Character>
        Parameters:
        predicate - the predicate used to test elements
        Returns:
        a new Seq

      • replace

        public CharSeq replace​(java.lang.Character currentElement,
                       java.lang.Character newElement)
        Description copied from interface: Traversable
        Replaces the first occurrence (if exists) of the given currentElement with newElement.
        Specified by:
        replace in interface IndexedSeq<java.lang.Character>
        Specified by:
        replace in interface Seq<java.lang.Character>
        Specified by:
        replace in interface Traversable<java.lang.Character>
        Parameters:
        currentElement - An element to be substituted.
        newElement - A replacement for currentElement.
        Returns:
        a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.

      • replaceAll

        public CharSeq replaceAll​(java.lang.Character currentElement,
                          java.lang.Character newElement)
        Description copied from interface: Traversable
        Replaces all occurrences of the given currentElement with newElement.
        Specified by:
        replaceAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        replaceAll in interface Seq<java.lang.Character>
        Specified by:
        replaceAll in interface Traversable<java.lang.Character>
        Parameters:
        currentElement - An element to be substituted.
        newElement - A replacement for currentElement.
        Returns:
        a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.

      • retainAll

        public CharSeq retainAll​(java.lang.Iterable<? extends java.lang.Character> elements)
        Description copied from interface: Traversable
        Keeps all occurrences of the given elements from this.
        Specified by:
        retainAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        retainAll in interface Seq<java.lang.Character>
        Specified by:
        retainAll in interface Traversable<java.lang.Character>
        Parameters:
        elements - Elements to be kept.
        Returns:
        a Traversable containing all occurrences of the given elements.

      • reverse

        public CharSeq reverse()
        Description copied from interface: Seq
        Reverses the order of elements.
        Specified by:
        reverse in interface IndexedSeq<java.lang.Character>
        Specified by:
        reverse in interface Seq<java.lang.Character>
        Returns:
        the reversed elements.

      • rotateLeft

        public CharSeq rotateLeft​(int n)
        Description copied from interface: Seq
        Circular rotates the elements by the specified distance to the left direction. 
        
 // = List(3, 4, 5, 1, 2)
 List.of(1, 2, 3, 4, 5).rotateLeft(2);
        Specified by:
        rotateLeft in interface IndexedSeq<java.lang.Character>
        Specified by:
        rotateLeft in interface Seq<java.lang.Character>
        Parameters:
        n - distance of left rotation
        Returns:
        the rotated elements.

      • rotateRight

        public CharSeq rotateRight​(int n)
        Description copied from interface: Seq
        Circular rotates the elements by the specified distance to the right direction. 
        
 // = List(4, 5, 1, 2, 3)
 List.of(1, 2, 3, 4, 5).rotateRight(2);
        Specified by:
        rotateRight in interface IndexedSeq<java.lang.Character>
        Specified by:
        rotateRight in interface Seq<java.lang.Character>
        Parameters:
        n - distance of right rotation
        Returns:
        the rotated elements.

      • scan

        public CharSeq scan​(java.lang.Character zero,
                    java.util.function.BiFunction<? super java.lang.Character,​? super java.lang.Character,​? extends java.lang.Character> operation)
        Description copied from interface: Traversable
        Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.
        Specified by:
        scan in interface IndexedSeq<java.lang.Character>
        Specified by:
        scan in interface Seq<java.lang.Character>
        Specified by:
        scan in interface Traversable<java.lang.Character>
        Parameters:
        zero - neutral element for the operator op
        operation - the associative operator for the scan
        Returns:
        a new traversable collection containing the prefix scan of the elements in this traversable collection

      • scanLeft

        public <U> IndexedSeq<U> scanLeft​(U zero,
                                  java.util.function.BiFunction<? super U,​? super java.lang.Character,​? extends U> operation)
        Description copied from interface: Traversable
        Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.
        Specified by:
        scanLeft in interface IndexedSeq<java.lang.Character>
        Specified by:
        scanLeft in interface Seq<java.lang.Character>
        Specified by:
        scanLeft in interface Traversable<java.lang.Character>
        Type Parameters:
        U - the type of the elements in the resulting collection
        Parameters:
        zero - the initial value
        operation - the binary operator applied to the intermediate result and the element
        Returns:
        collection with intermediate results

      • scanRight

        public <U> IndexedSeq<U> scanRight​(U zero,
                                   java.util.function.BiFunction<? super java.lang.Character,​? super U,​? extends U> operation)
        Description copied from interface: Traversable
        Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.
        Specified by:
        scanRight in interface IndexedSeq<java.lang.Character>
        Specified by:
        scanRight in interface Seq<java.lang.Character>
        Specified by:
        scanRight in interface Traversable<java.lang.Character>
        Type Parameters:
        U - the type of the elements in the resulting collection
        Parameters:
        zero - the initial value
        operation - the binary operator applied to the intermediate result and the element
        Returns:
        collection with intermediate results

      • shuffle

        public CharSeq shuffle()
        Description copied from interface: Seq
        Randomize the order of the elements in the current sequence.
        Specified by:
        shuffle in interface IndexedSeq<java.lang.Character>
        Specified by:
        shuffle in interface Seq<java.lang.Character>
        Returns:
        a sequence with the same elements as the current sequence in a random order.

      • shuffle

        public CharSeq shuffle​(java.util.Random random)
        Description copied from interface: Seq
        Randomize the order of the elements in the current sequence using the given source of randomness.
        Specified by:
        shuffle in interface IndexedSeq<java.lang.Character>
        Specified by:
        shuffle in interface Seq<java.lang.Character>
        Parameters:
        random - A random number generator
        Returns:
        a sequence with the same elements as the current sequence in a random order.

      • slice

        public CharSeq slice​(int beginIndex,
                     int endIndex)
        Description copied from interface: Seq
        Returns a Seq that is a slice of this. The slice begins with the element at the specified beginIndex and extends to the element at index endIndex - 1.

        Examples: 

         
 List.of(1, 2, 3, 4).slice(1, 3); // = (2, 3)
 List.of(1, 2, 3, 4).slice(0, 4); // = (1, 2, 3, 4)
 List.of(1, 2, 3, 4).slice(2, 2); // = ()
 List.of(1, 2).slice(1, 0);       // = ()
 List.of(1, 2).slice(-10, 10);    // = (1, 2)
        See also Seq.subSequence(int, int) which throws in some cases instead of returning a sequence.
        Specified by:
        slice in interface IndexedSeq<java.lang.Character>
        Specified by:
        slice in interface Seq<java.lang.Character>
        Parameters:
        beginIndex - the beginning index, inclusive
        endIndex - the end index, exclusive
        Returns:
        the specified slice

      • slideBy

        public Iterator<CharSeq> slideBy​(java.util.function.Function<? super java.lang.Character,​?> classifier)
        Description copied from interface: Traversable
        Slides a non-overlapping window of a variable size over this Traversable.

        Each window contains elements with the same class, as determined by classifier. Two consecutive values in this Traversable will be in the same window only if classifier returns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.

        Examples: 

        
 [].slideBy(Function.identity()) = []
 [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]]
 [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
        Specified by:
        slideBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        slideBy in interface Seq<java.lang.Character>
        Specified by:
        slideBy in interface Traversable<java.lang.Character>
        Parameters:
        classifier - A function which classifies elements into classes
        Returns:
        A new Iterator of windows of the grouped elements

      • sliding

        public Iterator<CharSeq> sliding​(int size)
        Description copied from interface: Traversable
        Slides a window of a specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).
        Specified by:
        sliding in interface IndexedSeq<java.lang.Character>
        Specified by:
        sliding in interface Seq<java.lang.Character>
        Specified by:
        sliding in interface Traversable<java.lang.Character>
        Parameters:
        size - a positive window size
        Returns:
        a new Iterator of windows of a specific size using step size 1

      • sliding

        public Iterator<CharSeq> sliding​(int size,
                                 int step)
        Description copied from interface: Traversable
        Slides a window of a specific size and step size over this Traversable.

        Examples: 

         
 [].sliding(1,1) = []
 [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
 [1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
 [1,2,3,4,5].sliding(2,5) = [[1,2]]
 [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
        Specified by:
        sliding in interface IndexedSeq<java.lang.Character>
        Specified by:
        sliding in interface Seq<java.lang.Character>
        Specified by:
        sliding in interface Traversable<java.lang.Character>
        Parameters:
        size - a positive window size
        step - a positive step size
        Returns:
        a new Iterator of windows of a specific size using a specific step size

      • sorted

        public CharSeq sorted()
        Description copied from interface: Seq
        Sorts this elements according to their natural order. If this elements are not Comparable, a java.lang.ClassCastException may be thrown.
        Specified by:
        sorted in interface IndexedSeq<java.lang.Character>
        Specified by:
        sorted in interface Seq<java.lang.Character>
        Returns:
        A sorted version of this

      • sorted

        public CharSeq sorted​(java.util.Comparator<? super java.lang.Character> comparator)
        Description copied from interface: Seq
        Sorts this elements according to the provided Comparator. If this elements are not Comparable, a java.lang.ClassCastException may be thrown.
        Specified by:
        sorted in interface IndexedSeq<java.lang.Character>
        Specified by:
        sorted in interface Seq<java.lang.Character>
        Parameters:
        comparator - A comparator
        Returns:
        a sorted version of this

      • sortBy

        public <U extends java.lang.Comparable<? super U>> CharSeq sortBy​(java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
        Description copied from interface: Seq
        Sorts this elements by comparing the elements in a different domain, using the given mapper.
        Specified by:
        sortBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        sortBy in interface Seq<java.lang.Character>
        Type Parameters:
        U - The domain where elements are compared
        Parameters:
        mapper - A mapper
        Returns:
        a sorted version of this

      • sortBy

        public <U> CharSeq sortBy​(java.util.Comparator<? super U> comparator,
                          java.util.function.Function<? super java.lang.Character,​? extends U> mapper)
        Description copied from interface: Seq
        Sorts this elements by comparing the elements in a different domain, using the given mapper.
        Specified by:
        sortBy in interface IndexedSeq<java.lang.Character>
        Specified by:
        sortBy in interface Seq<java.lang.Character>
        Type Parameters:
        U - The domain where elements are compared
        Parameters:
        comparator - A comparator
        mapper - A mapper
        Returns:
        a sorted version of this

      • span

        public Tuple2<CharSeq,​CharSeq> span​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Returns a tuple where the first element is the longest prefix of elements that satisfy the given predicate and the second element is the remainder.
        Specified by:
        span in interface IndexedSeq<java.lang.Character>
        Specified by:
        span in interface Seq<java.lang.Character>
        Specified by:
        span in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A predicate.
        Returns:
        a Tuple containing the longest prefix of elements that satisfy p and the remainder.

      • subSequence

        public CharSeq subSequence​(int beginIndex)
        Description copied from interface: Seq
        Returns a Seq that is a subsequence of this. The subsequence begins with the element at the specified beginIndex and extends to the end of this Seq.

        Examples: 

         
 List.of(1, 2).subSequence(0);     // = (1, 2)
 List.of(1, 2).subSequence(1);     // = (2)
 List.of(1, 2).subSequence(2);     // = ()
 List.of(1, 2).subSequence(10);    // throws IndexOutOfBoundsException
 List.of(1, 2).subSequence(-10);   // throws IndexOutOfBoundsException
        See also Seq.drop(int) which is similar but does not throw.
        Specified by:
        subSequence in interface IndexedSeq<java.lang.Character>
        Specified by:
        subSequence in interface Seq<java.lang.Character>
        Parameters:
        beginIndex - the beginning index, inclusive
        Returns:
        the specified subsequence

      • tail

        public CharSeq tail()
        Description copied from interface: Traversable
        Drops the first element of a non-empty Traversable.
        Specified by:
        tail in interface IndexedSeq<java.lang.Character>
        Specified by:
        tail in interface Seq<java.lang.Character>
        Specified by:
        tail in interface Traversable<java.lang.Character>
        Returns:
        A new instance of Traversable containing all elements except the first.

      • tailOption

        public Option<CharSeq> tailOption()
        Description copied from interface: Traversable
        Drops the first element of a non-empty Traversable and returns an Option.
        Specified by:
        tailOption in interface IndexedSeq<java.lang.Character>
        Specified by:
        tailOption in interface Seq<java.lang.Character>
        Specified by:
        tailOption in interface Traversable<java.lang.Character>
        Returns:
        Some(traversable) or None if this is empty.

      • take

        public CharSeq take​(int n)
        Description copied from interface: Traversable
        Takes the first n elements of this or all elements, if this length < n.

        The result is equivalent to sublist(0, max(0, min(length(), n))) but does not throw if n < 0 or n > length().

        In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.

        Specified by:
        take in interface IndexedSeq<java.lang.Character>
        Specified by:
        take in interface Seq<java.lang.Character>
        Specified by:
        take in interface Traversable<java.lang.Character>
        Parameters:
        n - The number of elements to take.
        Returns:
        A new instance consisting of the first n elements of this or all elements, if this has less than n elements.

      • takeUntil

        public CharSeq takeUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Takes elements until the predicate holds for the current element.

        Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

        Specified by:
        takeUntil in interface IndexedSeq<java.lang.Character>
        Specified by:
        takeUntil in interface Seq<java.lang.Character>
        Specified by:
        takeUntil in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements.
        Returns:
        a new instance consisting of all elements before the first one which does satisfy the given predicate.

      • takeWhile

        public CharSeq takeWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Traversable
        Takes elements while the predicate holds for the current element.
        Specified by:
        takeWhile in interface IndexedSeq<java.lang.Character>
        Specified by:
        takeWhile in interface Seq<java.lang.Character>
        Specified by:
        takeWhile in interface Traversable<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for the contained elements.
        Returns:
        a new instance consisting of all elements before the first one which does not satisfy the given predicate.

      • takeRight

        public CharSeq takeRight​(int n)
        Description copied from interface: Traversable
        Takes the last n elements of this or all elements, if this length < n.

        The result is equivalent to sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not throw if n < 0 or n > length().

        In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.

        Specified by:
        takeRight in interface IndexedSeq<java.lang.Character>
        Specified by:
        takeRight in interface Seq<java.lang.Character>
        Specified by:
        takeRight in interface Traversable<java.lang.Character>
        Parameters:
        n - The number of elements to take.
        Returns:
        A new instance consisting of the last n elements of this or all elements, if this has less than n elements.

      • takeRightUntil

        public CharSeq takeRightUntil​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Takes elements until the predicate holds for the current element, starting from the end.
        Specified by:
        takeRightUntil in interface IndexedSeq<java.lang.Character>
        Specified by:
        takeRightUntil in interface Seq<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements, starting from the end.
        Returns:
        a new instance consisting of all elements after the last one which does satisfy the given predicate.

      • takeRightWhile

        public CharSeq takeRightWhile​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Takes elements while the predicate holds for the current element, starting from the end.

        Note: This is essentially the same as takeRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

        Specified by:
        takeRightWhile in interface IndexedSeq<java.lang.Character>
        Specified by:
        takeRightWhile in interface Seq<java.lang.Character>
        Parameters:
        predicate - A condition tested subsequently for this elements, starting from the end.
        Returns:
        a new instance consisting of all elements after the last one which does not satisfy the given predicate.

      • transform

        public <U> U transform​(java.util.function.Function<? super CharSeq,​? extends U> f)
        Transforms this CharSeq.
        Type Parameters:
        U - Type of transformation result
        Parameters:
        f - A transformation
        Returns:
        An instance of type U
        Throws:
        java.lang.NullPointerException - if f is null

      • unzip

        public <T1,​T2> Tuple2<IndexedSeq<T1>,​IndexedSeq<T2>> unzip​(java.util.function.Function<? super java.lang.Character,​Tuple2<? extends T1,​? extends T2>> unzipper)
        Description copied from interface: Traversable
        Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.
        Specified by:
        unzip in interface IndexedSeq<java.lang.Character>
        Specified by:
        unzip in interface Seq<java.lang.Character>
        Specified by:
        unzip in interface Traversable<java.lang.Character>
        Type Parameters:
        T1 - 1st element type of a pair returned by unzipper
        T2 - 2nd element type of a pair returned by unzipper
        Parameters:
        unzipper - a function which converts elements of this to pairs
        Returns:
        A pair of set containing elements split by unzipper

      • unzip3

        public <T1,​T2,​T3> Tuple3<IndexedSeq<T1>,​IndexedSeq<T2>,​IndexedSeq<T3>> unzip3​(java.util.function.Function<? super java.lang.Character,​Tuple3<? extends T1,​? extends T2,​? extends T3>> unzipper)
        Description copied from interface: Traversable
        Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.
        Specified by:
        unzip3 in interface IndexedSeq<java.lang.Character>
        Specified by:
        unzip3 in interface Seq<java.lang.Character>
        Specified by:
        unzip3 in interface Traversable<java.lang.Character>
        Type Parameters:
        T1 - 1st element type of a triplet returned by unzipper
        T2 - 2nd element type of a triplet returned by unzipper
        T3 - 3rd element type of a triplet returned by unzipper
        Parameters:
        unzipper - a function which converts elements of this to pairs
        Returns:
        A triplet of set containing elements split by unzipper

      • update

        public CharSeq update​(int index,
                      java.lang.Character element)
        Description copied from interface: Seq
        Updates the given element at the specified index.
        Specified by:
        update in interface IndexedSeq<java.lang.Character>
        Specified by:
        update in interface Seq<java.lang.Character>
        Parameters:
        index - an index
        element - an element
        Returns:
        a new Seq consisting of all previous elements, with a single one (at the given index), changed to the new value.

      • update

        public CharSeq update​(int index,
                      java.util.function.Function<? super java.lang.Character,​? extends java.lang.Character> updater)
        Description copied from interface: Seq
        Updates the given element at the specified index using the specified function.
        Specified by:
        update in interface IndexedSeq<java.lang.Character>
        Specified by:
        update in interface Seq<java.lang.Character>
        Parameters:
        index - an index
        updater - a function transforming the previous value
        Returns:
        a new Seq consisting of all previous elements, with a single one (at the given index), changed to the new value.

      • zip

        public <U> IndexedSeq<Tuple2<java.lang.Character,​U>> zip​(java.lang.Iterable<? extends U> that)
        Description copied from interface: Traversable
        Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.

        The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

        Specified by:
        zip in interface IndexedSeq<java.lang.Character>
        Specified by:
        zip in interface Seq<java.lang.Character>
        Specified by:
        zip in interface Traversable<java.lang.Character>
        Type Parameters:
        U - The type of the second half of the returned pairs.
        Parameters:
        that - The Iterable providing the second half of each result pair.
        Returns:
        a new traversable containing pairs consisting of corresponding elements of this traversable and that iterable.

      • zipWith

        public <U,​R> IndexedSeq<R> zipWith​(java.lang.Iterable<? extends U> that,
                                         java.util.function.BiFunction<? super java.lang.Character,​? super U,​? extends R> mapper)
        Description copied from interface: Traversable
        Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.

        The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

        Specified by:
        zipWith in interface IndexedSeq<java.lang.Character>
        Specified by:
        zipWith in interface Seq<java.lang.Character>
        Specified by:
        zipWith in interface Traversable<java.lang.Character>
        Type Parameters:
        U - The type of the second parameter of the mapper.
        R - The type of the mapped elements.
        Parameters:
        that - The Iterable providing the second parameter of the mapper.
        mapper - a mapper.
        Returns:
        a new traversable containing mapped elements of this traversable and that iterable.

      • zipAll

        public <U> IndexedSeq<Tuple2<java.lang.Character,​U>> zipAll​(java.lang.Iterable<? extends U> that,
                                                                  java.lang.Character thisElem,
                                                                  U thatElem)
        Description copied from interface: Traversable
        Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

        The length of the returned traversable is the maximum of the lengths of this traversable and that iterable.

        Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.

        If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.

        Specified by:
        zipAll in interface IndexedSeq<java.lang.Character>
        Specified by:
        zipAll in interface Seq<java.lang.Character>
        Specified by:
        zipAll in interface Traversable<java.lang.Character>
        Type Parameters:
        U - The type of the second half of the returned pairs.
        Parameters:
        that - The Iterable providing the second half of each result pair.
        thisElem - The element to be used to fill up the result if this traversable is shorter than that.
        thatElem - The element to be used to fill up the result if that is shorter than this traversable.
        Returns:
        A new traversable containing pairs consisting of corresponding elements of this traversable and that.

      • zipWithIndex

        public IndexedSeq<Tuple2<java.lang.Character,​java.lang.Integer>> zipWithIndex()
        Description copied from interface: Traversable
        Zips this traversable with its indices.
        Specified by:
        zipWithIndex in interface IndexedSeq<java.lang.Character>
        Specified by:
        zipWithIndex in interface Seq<java.lang.Character>
        Specified by:
        zipWithIndex in interface Traversable<java.lang.Character>
        Returns:
        A new traversable containing all elements of this traversable paired with their index, starting with 0.

      • zipWithIndex

        public <U> IndexedSeq<U> zipWithIndex​(java.util.function.BiFunction<? super java.lang.Character,​? super java.lang.Integer,​? extends U> mapper)
        Description copied from interface: Traversable
        Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.

        The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

        Specified by:
        zipWithIndex in interface IndexedSeq<java.lang.Character>
        Specified by:
        zipWithIndex in interface Seq<java.lang.Character>
        Specified by:
        zipWithIndex in interface Traversable<java.lang.Character>
        Type Parameters:
        U - The type of the mapped elements.
        Parameters:
        mapper - a mapper.
        Returns:
        a new traversable containing mapped elements of this traversable and that iterable.

      • get

        public java.lang.Character get​(int index)
        Description copied from interface: Seq
        Returns the element at the specified index.
        Specified by:
        get in interface Seq<java.lang.Character>
        Parameters:
        index - an index
        Returns:
        the element at the given index

      • indexOf

        public int indexOf​(java.lang.Character element,
                   int from)
        Description copied from interface: Seq
        Returns the index of the first occurrence of the given element after or at some start index or -1 if this does not contain the given element.
        Specified by:
        indexOf in interface Seq<java.lang.Character>
        Parameters:
        element - an element
        from - start index
        Returns:
        the index of the first occurrence of the given element

      • lastIndexOf

        public int lastIndexOf​(java.lang.Character element,
                       int end)
        Description copied from interface: Seq
        Returns the index of the last occurrence of the given element before or at a given end index or -1 if this does not contain the given element.
        Specified by:
        lastIndexOf in interface Seq<java.lang.Character>
        Parameters:
        element - an element
        end - the end index
        Returns:
        the index of the last occurrence of the given element

      • splitAt

        public Tuple2<CharSeq,​CharSeq> splitAt​(int n)
        Description copied from interface: Seq
        Splits a Seq at the specified index. The result of splitAt(n) is equivalent to Tuple.of(take(n), drop(n)).
        Specified by:
        splitAt in interface Seq<java.lang.Character>
        Parameters:
        n - An index.
        Returns:
        A Tuple containing the first n and the remaining elements.

      • splitAt

        public Tuple2<CharSeq,​CharSeq> splitAt​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Splits a sequence at the first element which satisfies the Predicate, e.g. Tuple(init, element+tail).
        Specified by:
        splitAt in interface Seq<java.lang.Character>
        Parameters:
        predicate - An predicate
        Returns:
        A Tuple containing divided sequences

      • splitAtInclusive

        public Tuple2<CharSeq,​CharSeq> splitAtInclusive​(java.util.function.Predicate<? super java.lang.Character> predicate)
        Description copied from interface: Seq
        Splits a sequence at the first element which satisfies the Predicate, e.g. Tuple(init+element, tail).
        Specified by:
        splitAtInclusive in interface Seq<java.lang.Character>
        Parameters:
        predicate - An predicate
        Returns:
        A Tuple containing divided sequences

      • startsWith

        public boolean startsWith​(java.lang.Iterable<? extends java.lang.Character> that,
                          int offset)
        Description copied from interface: Seq
        Tests whether this list contains the given sequence at a given index.

        Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.

        Specified by:
        startsWith in interface IndexedSeq<java.lang.Character>
        Specified by:
        startsWith in interface Seq<java.lang.Character>
        Parameters:
        that - the sequence to test
        offset - the index where the sequence is searched.
        Returns:
        true if that is empty or that is prefix of this collection starting from the given offset, false otherwise.

      • head

        public java.lang.Character head()
        Description copied from interface: Traversable
        Returns the first element of a non-empty Traversable.
        Specified by:
        head in interface Traversable<java.lang.Character>
        Returns:
        The first element of this Traversable.

      • isAsync

        public boolean isAsync()
        A CharSeq is computed synchronously.
        Specified by:
        isAsync in interface Value<java.lang.Character>
        Returns:
        false

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Traversable
        Checks if this Traversable is empty.
        Specified by:
        isEmpty in interface Traversable<java.lang.Character>
        Specified by:
        isEmpty in interface Value<java.lang.Character>
        Returns:
        true, if this Traversable contains no elements, false otherwise.

      • isLazy

        public boolean isLazy()
        A CharSeq is computed eagerly.
        Specified by:
        isLazy in interface Value<java.lang.Character>
        Returns:
        false

      • isTraversableAgain

        public boolean isTraversableAgain()
        Description copied from interface: Traversable
        Checks if this Traversable can be repeatedly traversed.

        This method should be implemented by classes only, i.e. not by interfaces.

        Specified by:
        isTraversableAgain in interface Traversable<java.lang.Character>
        Returns:
        true, if this Traversable is known to be traversable repeatedly, false otherwise.

      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: Traversable
        In Vavr there are four basic classes of collections:
        • Seq (sequential elements)
        • Set (distinct elements)
        • Map (indexed elements)
        • Multimap (indexed collections)
        Two collection instances of these classes are equal if and only if both collections
        • belong to the same basic collection class (Seq, Set, Map or Multimap)
        • contain the same elements
        • have the same element order, if the collections are of type Seq
        Two Map/Multimap elements, resp. entries, (key1, value1) and (key2, value2) are equal, if the keys are equal and the values are equal.

        Notes:

        • No collection instance equals null, e.g. Queue(1) not equals null.
        • Nulls are allowed and handled as expected, e.g. List(null, 1) equals Stream(null, 1) and HashMap((null, 1)) equals LinkedHashMap((null, 1)).
        • The element order is taken into account for Seq only. E.g. List(null, 1) not equals Stream(1, null) and HashMap((null, 1), ("a", null)) equals LinkedHashMap(("a", null), (null, 1)). The reason is, that we do not know which implementations we compare when having two instances of type Map, Multimap or Set (see Liskov Substitution Principle).
        • Other collection classes are equal if their types are equal and their elements are equal (in iteration order).
        • Iterator equality is defined to be object reference equality.
        Specified by:
        equals in interface Traversable<java.lang.Character>
        Specified by:
        equals in interface Value<java.lang.Character>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - an object, may be null
        Returns:
        true, if this collection equals the given object according to the rules described above, false otherwise.

      • hashCode

        public int hashCode()
        Description copied from interface: Traversable
        Returns the hash code of this collection.
        We distinguish between two types of hashes, those for collections with predictable iteration order (like Seq) and those with arbitrary iteration order (like Set, Map and Multimap).
        In all cases the hash of an empty collection is defined to be 1.
        Collections with predictable iteration order are hashed as follows: 
        
 int hash = 1;
 for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
        Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order. 
        
 int hash = 1;
 for (T t : this) { hash += Objects.hashCode(t); }
        Please note that the particular hashing algorithms may change in a future version of Vavr.
        Generally, hash codes of collections aren't cached in Vavr (opposed to the size/length). Storing hash codes in order to reduce the time complexity would increase the memory footprint. Persistent collections are built upon tree structures, it allows us to implement efficient memory sharing. A drawback of tree structures is that they make it necessary to store collection attributes at each tree node (read: element).
        The computation of the hash code is linear in time, i.e. O(n). If the hash code of a collection is re-calculated often, e.g. when using a List as HashMap key, we might want to cache the hash code. This can be achieved by simply using a wrapper class, which is not included in Vavr but could be implemented like this: 
        public final class Hashed<K> {

     private final K key;
     private final Lazy<Integer> hashCode;

     public Hashed(K key) {
         this.key = key;
         this.hashCode = Lazy.of(() -> Objects.hashCode(key));
     }

     public K key() {
         return key;
     }

     &#64;Override
     public boolean equals(Object o) {
         if (o == key) {
             return true;
         } else if (key != null && o instanceof Hashed) {
             final Hashed that = (Hashed) o;
             return key.equals(that.key);
         } else {
             return false;
         }
     }

     &#64;Override
     public int hashCode() {
         return hashCode.get();
     }

     &#64;Override
     public String toString() {
         return "Hashed(" + (key == null ? "null" : key.toString()) + ")";
     }
 }
        Specified by:
        hashCode in interface Traversable<java.lang.Character>
        Specified by:
        hashCode in interface Value<java.lang.Character>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code of this collection

      • charAt

        public char charAt​(int index)
        Returns the char value at the specified index. An index ranges from 0 to length() - 1. The first char value of the sequence is at index 0, the next at index 1, and so on, as for array indexing.

        If the char value specified by the index is a surrogate, the surrogate value is returned.

        Specified by:
        charAt in interface java.lang.CharSequence
        Parameters:
        index - the index of the char value.
        Returns:
        the char value at the specified index of this string. The first char value is at index 0.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.

      • length

        public int length()
        Returns the length of this string. The length is equal to the number of Unicode code units in the string.
        Specified by:
        length in interface java.lang.CharSequence
        Specified by:
        length in interface Traversable<java.lang.Character>
        Returns:
        the length of the sequence of characters represented by this object.

      • codePointAt

        public int codePointAt​(int index)
        Returns the character (Unicode code point) at the specified index. The index refers to char values (Unicode code units) and ranges from 0 to 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 CharSeq, 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
        Returns:
        the code point value of the character at the index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.

      • codePointBefore

        public int codePointBefore​(int index)
        Returns the character (Unicode code point) before the specified index. The index refers to char values (Unicode code units) and ranges from 1 to 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
        Returns:
        the Unicode code point value before the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index argument is less than 1 or greater than the length of this string.

      • codePointCount

        public int codePointCount​(int beginIndex,
                          int endIndex)
        Returns the number of Unicode code points in the specified text range of this CharSeq. 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 the text range count as one code point each.
        Parameters:
        beginIndex - the index to the first char of the text range.
        endIndex - the index after the last char of the text range.
        Returns:
        the number of Unicode code points in the specified text range
        Throws:
        java.lang.IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this CharSeq, or beginIndex is larger than endIndex.

      • offsetByCodePoints

        public int offsetByCodePoints​(int index,
                              int codePointOffset)
        Returns the index within this CharSeq 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
        codePointOffset - the offset in code points
        Returns:
        the index within this CharSeq
        Throws:
        java.lang.IndexOutOfBoundsException - if index is negative or larger then the length of this CharSeq, or if codePointOffset is positive and the substring starting with index has fewer than codePointOffset code points, or if codePointOffset is negative and the substring before index has fewer than the absolute value of codePointOffset code points.

      • getChars

        public void getChars​(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)
        Copies characters from this string into the destination character array.

        The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1 (thus 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 - index of the first character in the string to copy.
        srcEnd - index after the last character in the string to copy.
        dst - the destination array.
        dstBegin - the start offset in the destination array.
        Throws:
        java.lang.IndexOutOfBoundsException - If any of the following is true:
        • srcBegin is negative.
        • srcBegin is greater than srcEnd
        • srcEnd is greater than the length of this string
        • dstBegin is negative
        • dstBegin+(srcEnd-srcBegin) is larger than dst.length

      • getBytes

        public byte[] getBytes​(java.lang.String charsetName)
                throws java.io.UnsupportedEncodingException
        Encodes this CharSeq into a sequence of bytes using the named charset, storing the result into a new byte array.

        The behavior of this method when this string cannot be encoded in the given charset is unspecified. The CharsetEncoder class should be used when more control over the encoding process is required.

        Parameters:
        charsetName - The name of a supported charset
        Returns:
        The resultant byte array
        Throws:
        java.io.UnsupportedEncodingException - If the named charset is not supported

      • getBytes

        public byte[] getBytes​(java.nio.charset.Charset charset)
        Encodes this CharSeq into a sequence of bytes using the given charset, storing the result into a new byte array.

        This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement byte array. The CharsetEncoder class should be used when more control over the encoding process is required.

        Parameters:
        charset - The Charset to be used to encode the CharSeq
        Returns:
        The resultant byte array

      • getBytes

        public byte[] getBytes()
        Encodes this CharSeq into a sequence of bytes using the platform's default charset, storing the result into a new byte array.

        The behavior of this method when this string cannot be encoded in the default charset is unspecified. The CharsetEncoder class should be used when more control over the encoding process is required.

        Returns:
        The resultant byte array

      • contentEquals

        public boolean contentEquals​(java.lang.StringBuffer sb)
        Compares this string to the specified StringBuffer. The result is true if and only if this CharSeq represents the same sequence of characters as the specified StringBuffer. This method synchronizes on the StringBuffer.
        Parameters:
        sb - The StringBuffer to compare this CharSeq against
        Returns:
        true if this CharSeq represents the same sequence of characters as the specified StringBuffer, false otherwise

      • contentEquals

        public boolean contentEquals​(java.lang.CharSequence cs)
        Compares this string to the specified CharSequence. The result is true if and only if this CharSeq represents the same sequence of char values as the specified sequence. Note that if the CharSequence is a StringBuffer then the method synchronizes on it.
        Parameters:
        cs - The sequence to compare this CharSeq against
        Returns:
        true if this CharSeq represents the same sequence of char values as the specified sequence, false otherwise

      • equalsIgnoreCase

        public boolean equalsIgnoreCase​(CharSeq anotherString)
        Compares this CharSeq to another CharSeq, ignoring case considerations. Two strings are considered equal ignoring case if they are of the same length and corresponding characters in the two strings are equal ignoring case.

        Two characters c1 and c2 are considered the same ignoring case if at least one of the following is true:

        • The two characters are the same (as compared by the == operator)
        • Applying the method Character.toUpperCase(char) to each character produces the same result
        • Applying the method Character.toLowerCase(char) to each character produces the same result
        Parameters:
        anotherString - The CharSeq to compare this CharSeq against
        Returns:
        true if the argument is not null and it represents an equivalent CharSeq ignoring case; false otherwise
        See Also:
        equals(Object)

      • compareTo

        public int compareTo​(CharSeq anotherString)
        Compares two strings lexicographically. The comparison is based on the Unicode value of each character in the strings. The character sequence represented by this CharSeq object is compared lexicographically to the character sequence represented by the argument string. The result is a negative integer if this CharSeq object lexicographically precedes the argument string. The result is a positive integer if this CharSeq object lexicographically follows the argument string. The result is zero if the strings are equal; compareTo returns 0 exactly when the equals(Object) method would return true.

        This is the definition of lexicographic ordering. If two strings are different, then either they have different characters at some index that is a valid index for both strings, or their lengths are different, or both. If they have different characters at one or more index positions, let k be the smallest such index; then the string whose character at position k has the smaller value, as determined by using the < operator, lexicographically precedes the other string. In this case, compareTo returns the difference of the two character values at position k in the two string -- that is, the value: 

         this.charAt(k)-anotherString.charAt(k)
        If there is no index position at which they differ, then the shorter string lexicographically precedes the longer string. In this case, compareTo returns the difference of the lengths of the strings -- that is, the value: 
         this.length()-anotherString.length()
        Specified by:
        compareTo in interface java.lang.Comparable<CharSeq>
        Parameters:
        anotherString - the CharSeq to be compared.
        Returns:
        the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.

      • compareToIgnoreCase

        public int compareToIgnoreCase​(CharSeq str)
        Compares two strings lexicographically, ignoring case differences. This method returns an integer whose sign is that of calling compareTo with normalized versions of the strings where case differences have been eliminated by calling Character.toLowerCase(Character.toUpperCase(character)) on each character.

        Note that this method does not take locale into account, and will result in an unsatisfactory ordering for certain locales. The java.text package provides collators to allow locale-sensitive ordering.

        Parameters:
        str - the CharSeq to be compared.
        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.

      • regionMatches

        public boolean regionMatches​(int toffset,
                             CharSeq other,
                             int ooffset,
                             int len)
        Tests if two string regions are equal.

        A substring of this CharSeq object is compared to a substring of the argument other. The result is true if these substrings represent identical character sequences. The substring of this CharSeq object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

        • toffset is negative.
        • ooffset is negative.
        • toffset+len is greater than the length of this CharSeq object.
        • ooffset+len is greater than the length of the other argument.
        • There is some nonnegative integer k less than len such that: this.charAt(toffset + k) != other.charAt(ooffset + k)
        Parameters:
        toffset - the starting offset of the subregion in this string.
        other - the string argument.
        ooffset - the starting offset of the subregion in the string argument.
        len - the number of characters to compare.
        Returns:
        true if the specified subregion of this string exactly matches the specified subregion of the string argument; false otherwise.

      • regionMatches

        public boolean regionMatches​(boolean ignoreCase,
                             int toffset,
                             CharSeq other,
                             int ooffset,
                             int len)
        Tests if two string regions are equal.

        A substring of this CharSeq object is compared to a substring of the argument other. The result is true if these substrings represent character sequences that are the same, ignoring case if and only if ignoreCase is true. The substring of this CharSeq object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

        • toffset is negative.
        • ooffset is negative.
        • toffset+len is greater than the length of this CharSeq object.
        • ooffset+len is greater than the length of the other argument.
        • ignoreCase is false and there is some nonnegative integer k less than len such that: 
           this.charAt(toffset+k) != other.charAt(ooffset+k)
        • ignoreCase is true and there is some nonnegative integer k less than len such that: 
           Character.toLowerCase(this.charAt(toffset+k)) !=
 Character.toLowerCase(other.charAt(ooffset+k))
          and: 
           Character.toUpperCase(this.charAt(toffset+k)) !=
         Character.toUpperCase(other.charAt(ooffset+k))
        Parameters:
        ignoreCase - if true, ignore case when comparing characters.
        toffset - the starting offset of the subregion in this string.
        other - the string argument.
        ooffset - the starting offset of the subregion in the string argument.
        len - the number of characters to compare.
        Returns:
        true if the specified subregion of this string matches the specified subregion of the string argument; false otherwise. Whether the matching is exact or case insensitive depends on the ignoreCase argument.

      • subSequence

        public CharSeq subSequence​(int beginIndex,
                           int endIndex)
        Description copied from interface: Seq
        Returns a Seq that is a subsequence of this. The subsequence begins with the element at the specified beginIndex and extends to the element at index endIndex - 1.

        Examples: 

         
 List.of(1, 2, 3, 4).subSequence(1, 3); // = (2, 3)
 List.of(1, 2, 3, 4).subSequence(0, 4); // = (1, 2, 3, 4)
 List.of(1, 2, 3, 4).subSequence(2, 2); // = ()
 List.of(1, 2).subSequence(1, 0);       // throws IndexOutOfBoundsException
 List.of(1, 2).subSequence(-10, 1);     // throws IndexOutOfBoundsException
 List.of(1, 2).subSequence(0, 10);      // throws IndexOutOfBoundsException
        See also Seq.slice(int, int) which returns an empty sequence instead of throwing.
        Specified by:
        subSequence in interface java.lang.CharSequence
        Specified by:
        subSequence in interface IndexedSeq<java.lang.Character>
        Specified by:
        subSequence in interface Seq<java.lang.Character>
        Parameters:
        beginIndex - the beginning index, inclusive
        endIndex - the end index, exclusive
        Returns:
        the specified subsequence

      • startsWith

        public boolean startsWith​(CharSeq prefix,
                          int toffset)
        Tests if the substring of this string beginning at the specified index starts with the specified prefix.
        Parameters:
        prefix - the prefix.
        toffset - where to begin looking in this string.
        Returns:
        true if the character sequence represented by the argument is a prefix of the substring of this object starting at index toffset; false otherwise. The result is false if toffset is negative or greater than the length of this CharSeq object; otherwise the result is the same as the result of the expression 
                  this.substring(toffset).startsWith(prefix)

      • startsWith

        public boolean startsWith​(CharSeq prefix)
        Tests if this string starts with the specified prefix.
        Parameters:
        prefix - the prefix.
        Returns:
        true if the character sequence represented by the argument is a prefix of the character sequence represented by this string; false otherwise. Note also that true will be returned if the argument is an empty string or is equal to this CharSeq object as determined by the equals(Object) method.

      • endsWith

        public boolean endsWith​(CharSeq suffix)
        Tests if this string ends with the specified suffix.
        Parameters:
        suffix - the suffix.
        Returns:
        true if the character sequence represented by the argument is a suffix of the character sequence represented by this object; false otherwise. Note that the result will be true if the argument is the empty string or is equal to this CharSeq object as determined by the equals(Object) method.

      • indexOf

        public int indexOf​(int ch)
        Returns the index within this string of the first occurrence of the specified character. If a character with value ch occurs in the character sequence represented by this CharSeq object, then the index (in Unicode code units) of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that: 
         this.charAt(k) == ch
        is true. For other values of ch, it is the smallest value k such that: 
         this.codePointAt(k) == ch
        is true. In either case, if no such character occurs in this string, then -1 is returned.
        Parameters:
        ch - a character (Unicode code point).
        Returns:
        the index of the first occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

      • indexOf

        public int indexOf​(int ch,
                   int fromIndex)
        Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.

        If a character with value ch occurs in the character sequence represented by this CharSeq object at an index no smaller than fromIndex, then the index of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that: 

         (this.charAt(k) == ch) && (k >= fromIndex)
        is true. For other values of ch, it is the smallest value k such that: 
         (this.codePointAt(k) == ch) && (k >= fromIndex)
        is true. In either case, if no such character occurs in this string at or after position fromIndex, then -1 is returned.

        There is no restriction on the value of fromIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned.

        All indices are specified in char values (Unicode code units).

        Parameters:
        ch - a character (Unicode code point).
        fromIndex - the index to start the search from.
        Returns:
        the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to fromIndex, or -1 if the character does not occur.

      • lastIndexOf

        public int lastIndexOf​(int ch)
        Returns the index within this string of the last occurrence of the specified character. For values of ch in the range from 0 to 0xFFFF (inclusive), the index (in Unicode code units) returned is the largest value k such that: 
         this.charAt(k) == ch
        is true. For other values of ch, it is the largest value k such that: 
         this.codePointAt(k) == ch
        is true. In either case, if no such character occurs in this string, then -1 is returned. The CharSeq is searched backwards starting at the last character.
        Parameters:
        ch - a character (Unicode code point).
        Returns:
        the index of the last occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

      • lastIndexOf

        public int lastIndexOf​(int ch,
                       int fromIndex)
        Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. For values of ch in the range from 0 to 0xFFFF (inclusive), the index returned is the largest value k such that: 
         (this.charAt(k) == ch) && (k <= fromIndex)
        is true. For other values of ch, it is the largest value k such that: 
         (this.codePointAt(k) == ch) && (k <= fromIndex)
        is true. In either case, if no such character occurs in this string at or before position fromIndex, then -1 is returned.

        All indices are specified in char values (Unicode code units).

        Parameters:
        ch - a character (Unicode code point).
        fromIndex - the index to start the search from. There is no restriction on the value of fromIndex. If it is greater than or equal to the length of this string, it has the same effect as if it were equal to one less than the length of this string: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.
        Returns:
        the index of the last occurrence of the character in the character sequence represented by this object that is less than or equal to fromIndex, or -1 if the character does not occur before that point.

      • lastIndexOfOption

        public Option<java.lang.Integer> lastIndexOfOption​(int ch,
                                                   int fromIndex)
        Returns the index of the last occurrence of the given element as an Option, starting the search at the specified index.
        Parameters:
        ch - a character (Unicode code point).
        fromIndex - the index to start the search from.
        Returns:
        Some(index) or None if not found.

      • indexOf

        public int indexOf​(CharSeq str)
        Returns the index within this string of the first occurrence of the specified substring.

        The returned index is the smallest value k for which: 

         this.startsWith(str, k)
        If no such value of k exists, then -1 is returned.
        Parameters:
        str - the substring to search for.
        Returns:
        the index of the first occurrence of the specified substring, or -1 if there is no such occurrence.

      • indexOfOption

        public Option<java.lang.Integer> indexOfOption​(CharSeq str)
        Returns the index of the first occurrence of the given element as an Option.
        Parameters:
        str - the substring to search for.
        Returns:
        Some(index) or None if not found.

      • indexOf

        public int indexOf​(CharSeq str,
                   int fromIndex)
        Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

        The returned index is the smallest value k for which: 

         k >= fromIndex && this.startsWith(str, k)
        If no such value of k exists, then -1 is returned.
        Parameters:
        str - the substring to search for.
        fromIndex - the index from which to start the search.
        Returns:
        the index of the first occurrence of the specified substring, starting at the specified index, or -1 if there is no such occurrence.

      • indexOfOption

        public Option<java.lang.Integer> indexOfOption​(CharSeq str,
                                               int fromIndex)
        Returns the index of the first occurrence of the given element as an Option, starting the search at the specified index.
        Parameters:
        str - the substring to search for.
        fromIndex - the index from which to start the search.
        Returns:
        Some(index) or None if not found.

      • lastIndexOf

        public int lastIndexOf​(CharSeq str)
        Returns the index within this string of the last occurrence of the specified substring. The last occurrence of the empty string "" is considered to occur at the index value this.length().

        The returned index is the largest value k for which: 

         this.startsWith(str, k)
        If no such value of k exists, then -1 is returned.
        Parameters:
        str - the substring to search for.
        Returns:
        the index of the last occurrence of the specified substring, or -1 if there is no such occurrence.

      • lastIndexOfOption

        public Option<java.lang.Integer> lastIndexOfOption​(CharSeq str)
        Returns the index of the last occurrence of the given element as an Option.
        Parameters:
        str - the substring to search for.
        Returns:
        Some(index) or None if not found.

      • lastIndexOf

        public int lastIndexOf​(CharSeq str,
                       int fromIndex)
        Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.

        The returned index is the largest value k for which: 

         k <= fromIndex && this.startsWith(str, k)
        If no such value of k exists, then -1 is returned.
        Parameters:
        str - the substring to search for.
        fromIndex - the index to start the search from.
        Returns:
        the index of the last occurrence of the specified substring, searching backward from the specified index, or -1 if there is no such occurrence.

      • lastIndexOfOption

        public Option<java.lang.Integer> lastIndexOfOption​(CharSeq str,
                                                   int fromIndex)
        Returns the index of the last occurrence of the given element as an Option, starting the search at the specified index.
        Parameters:
        str - the substring to search for.
        fromIndex - the index to start the search from.
        Returns:
        Some(index) or None if not found.

      • substring

        public CharSeq substring​(int beginIndex)
        Returns a string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

        Examples: 

         "unhappy".substring(2) returns "happy"
 "Harbison".substring(3) returns "bison"
 "emptiness".substring(9) returns "" (an empty string)
        Parameters:
        beginIndex - the beginning index, inclusive.
        Returns:
        the specified substring.
        Throws:
        java.lang.IndexOutOfBoundsException - if beginIndex is negative or larger than the length of this CharSeq object.

      • substring

        public CharSeq substring​(int beginIndex,
                         int endIndex)
        Returns a string that is a substring of this 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: 

         "hamburger".substring(4, 8) returns "urge"
 "smiles".substring(1, 5) returns "mile"
        Parameters:
        beginIndex - the beginning index, inclusive.
        endIndex - the ending index, exclusive.
        Returns:
        the specified substring.
        Throws:
        java.lang.IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this CharSeq object, or beginIndex is larger than endIndex.

      • stringPrefix

        public java.lang.String stringPrefix()
        Description copied from interface: Value
        Returns the name of this Value type, which is used by toString().
        Specified by:
        stringPrefix in interface Value<java.lang.Character>
        Returns:
        This type name.

      • toString

        public java.lang.String toString()
        Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.
        Specified by:
        toString in interface java.lang.CharSequence
        Specified by:
        toString in interface Value<java.lang.Character>
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string consisting of exactly this sequence of characters

      • concat

        public CharSeq concat​(CharSeq str)
        Concatenates the specified string to the end of this string.

        If the length of the argument string is 0, then this CharSeq object is returned. Otherwise, a CharSeq object is returned that represents a character sequence that is the concatenation of the character sequence represented by this CharSeq object and the character sequence represented by the argument string.

        Examples: 

         "cares".concat("s") returns "caress"
 "to".concat("get").concat("her") returns "together"
        Parameters:
        str - the CharSeq that is concatenated to the end of this CharSeq.
        Returns:
        a string that represents the concatenation of this object's characters followed by the string argument's characters.

      • matches

        public boolean matches​(java.lang.String regex)
        Tells whether or not this string matches the given regular expression.

        An invocation of this method of the form str.matches(regex) yields exactly the same result as the expression

        Pattern.matches(regex, str)
        Parameters:
        regex - the regular expression to which this string is to be matched
        Returns:
        true if, and only if, this string matches the given regular expression
        Throws:
        java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid
        See Also:
        Pattern

      • contains

        public boolean contains​(java.lang.CharSequence s)
        Returns true if and only if this string contains the specified sequence of char values.
        Parameters:
        s - the sequence to search for
        Returns:
        true if this string contains s, false otherwise

      • replaceFirst

        public CharSeq replaceFirst​(java.lang.String regex,
                            java.lang.String replacement)
        Replaces the first substring of this string that matches the given regular expression with the given replacement.

        An invocation of this method of the form str.replaceFirst(regex, repl) yields exactly the same result as the expression

        Pattern.compile(regex).matcher(str).replaceFirst(repl)
        Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceFirst(java.lang.String). Use Matcher.quoteReplacement(java.lang.String) to suppress the special meaning of these characters, if desired.
        Parameters:
        regex - the regular expression to which this string is to be matched
        replacement - the string to be substituted for the first match
        Returns:
        The resulting CharSeq
        Throws:
        java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid
        See Also:
        Pattern

      • replaceAll

        public CharSeq replaceAll​(java.lang.String regex,
                          java.lang.String replacement)
        Replaces each substring of this string that matches the given regular expression with the given replacement.

        An invocation of this method of the form str.replaceAll(regex, repl) yields exactly the same result as the expression

        Pattern.compile(regex).matcher(str).replaceAll(repl)
        Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceAll. Use Matcher.quoteReplacement(java.lang.String) to suppress the special meaning of these characters, if desired.
        Parameters:
        regex - the regular expression to which this string is to be matched
        replacement - the string to be substituted for each match
        Returns:
        The resulting CharSeq
        Throws:
        java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid
        See Also:
        Pattern

      • replace

        public CharSeq replace​(java.lang.CharSequence target,
                       java.lang.CharSequence replacement)
        Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the string "aaa" will result in "ba" rather than "ab".
        Parameters:
        target - The sequence of char values to be replaced
        replacement - The replacement sequence of char values
        Returns:
        The resulting string

      • split

        public Seq<CharSeq> split​(java.lang.String regex)
        Splits this string around matches of the given regular expression.

        This method works as if by invoking the two-argument split(String, int) method with the given expression and a limit argument of zero. Trailing empty strings are therefore not included in the resulting Seq.

        The string "boo:and:foo", for example, yields the following results with these expressions:

        Split examples showing regex and result
        Regex Result
        : { "boo", "and", "foo" }
        o { "b", "", ":and:f" }
        Parameters:
        regex - the delimiting regular expression
        Returns:
        the Seq of strings computed by splitting this string around matches of the given regular expression
        Throws:
        java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid
        See Also:
        Pattern

      • split

        public Seq<CharSeq> split​(java.lang.String regex,
                          int limit)
        Splits this string around matches of the given regular expression.

        The array returned by this method contains each substring of this string that is terminated by another substring that matches the given expression or is terminated by the end of the string. The substrings in the array are in the order in which they occur in this string. If the expression does not match any part of the input then the resulting array has just one element, namely this string.

        When there is a positive-width match at the beginning of this string then an empty leading substring is included at the beginning of the resulting array. A zero-width match at the beginning however never produces such empty leading substring.

        The limit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array. If the limit n is greater than zero then the pattern will be applied at most n - 1 times, the array's length will be no greater than n, and the array's last entry will contain all input beyond the last matched delimiter. If n is non-positive then the pattern will be applied as many times as possible and the array can have any length. If n is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded.

        The string "boo:and:foo", for example, yields the following results with these parameters:

        Split example showing regex, limit, and result
        Regex Limit Result
        : 2 { "boo", "and:foo" }
        : 5 { "boo", "and", "foo" }
        : -2 { "boo", "and", "foo" }
        o 5 { "b", "", ":and:f", "", "" }
        o -2 { "b", "", ":and:f", "", "" }
        o 0 { "b", "", ":and:f" }
        An invocation of this method of the form str.split(regex, n) yields the same result as the expression
        Pattern.compile(regex).split(str, n)
        Parameters:
        regex - the delimiting regular expression
        limit - the result threshold, as described above
        Returns:
        the Seq of strings computed by splitting this string around matches of the given regular expression
        Throws:
        java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid
        See Also:
        Pattern

      • toLowerCase

        public CharSeq toLowerCase​(java.util.Locale locale)
        Converts all of the characters in this CharSeq to lower case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting CharSeq may be a different length than the original CharSeq.

        Examples of lowercase mappings are in the following table:

        Lowercase mapping examples showing language code of locale, upper case, lower case, and description
        Language Code of Locale Upper Case Lower Case Description
        tr (Turkish) \u0130 \u0069 capital letter I with dot above -> small letter i
        tr (Turkish) \u0049 \u0131 capital letter I -> small letter dotless i
        (all) French Fries french fries lowercased all chars in String
        (all) capiotacapchi capthetacapupsil capsigma iotachi thetaupsilon sigma lowercased all chars in String
        Parameters:
        locale - use the case transformation rules for this locale
        Returns:
        the CharSeq, converted to lowercase.
        See Also:
        String.toLowerCase(), String.toUpperCase(), String.toUpperCase(Locale)

      • toLowerCase

        public CharSeq toLowerCase()
        Converts all of the characters in this CharSeq to lower case using the rules of the default locale. This is equivalent to calling toLowerCase(Locale.getDefault()).

        Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "TITLE".toLowerCase() in a Turkish locale returns "t\u0131tle", where '\u0131' is the LATIN SMALL LETTER DOTLESS I character. To obtain correct results for locale insensitive strings, use toLowerCase(Locale.ROOT).

        Returns:
        the CharSeq, converted to lowercase.
        See Also:
        String.toLowerCase(Locale)

      • toUpperCase

        public CharSeq toUpperCase​(java.util.Locale locale)
        Converts all of the characters in this CharSeq to upper case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting CharSeq may be a different length than the original CharSeq.

        Examples of locale-sensitive and 1:M case mappings are in the following table.

        Examples of locale-sensitive and 1:M case mappings. Shows Language code of locale, lower case, upper case, and description.
        Language Code of Locale Lower Case Upper Case Description
        tr (Turkish) \u0069 \u0130 small letter i -> capital letter I with dot above
        tr (Turkish) \u0131 \u0049 small letter dotless i -> capital letter I
        (all) \u00df \u0053 \u0053 small letter sharp s -> two letters: SS
        (all) Fahrvergnügen FAHRVERGNÜGEN
        Parameters:
        locale - use the case transformation rules for this locale
        Returns:
        the CharSeq, converted to uppercase.
        See Also:
        String.toUpperCase(), String.toLowerCase(), String.toLowerCase(Locale)

      • toUpperCase

        public CharSeq toUpperCase()
        Converts all of the characters in this CharSeq to upper case using the rules of the default locale. This method is equivalent to toUpperCase(Locale.getDefault()).

        Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "title".toUpperCase() in a Turkish locale returns "T\u0130TLE", where '\u0130' is the LATIN CAPITAL LETTER I WITH DOT ABOVE character. To obtain correct results for locale insensitive strings, use toUpperCase(Locale.ROOT).

        Returns:
        the CharSeq, converted to uppercase.
        See Also:
        String.toUpperCase(Locale)

      • capitalize

        public CharSeq capitalize​(java.util.Locale locale)
        Converts the first character in this CharSeq to upper case using the rules of the given Locale. If the CharSeq is empty, it won't have any effect. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting CharSeq may be a different length than the original CharSeq.

        Examples of locale-sensitive and 1:M case mappings are in the following table.

        Examples of locale-sensitive and 1:M case mappings. Shows Language code of locale, lower case, upper case, and description.
        Language Code of Locale Lower Case Upper Case Description
        tr (Turkish) \u0069 \u0130 small letter i -> capital letter I with dot above
        tr (Turkish) \u0131 \u0049 small letter dotless i -> capital letter I
        (all) \u00df \u0053 \u0053 small letter sharp s -> two letters: SS
        (all) Fahrvergnügen FAHRVERGNÜGEN
        Parameters:
        locale - use the case transformation rules for this locale
        Returns:
        the CharSeq, capitalized.

      • capitalize

        public CharSeq capitalize()
        Converts the first character in this CharSeq to upper case using the rules of the default locale. If the CharSeq is empty, it won't have any effect. This method is equivalent to capitalize(Locale.getDefault()).

        Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "title".toUpperCase() in a Turkish locale returns "T\u0130TLE", where '\u0130' is the LATIN CAPITAL LETTER I WITH DOT ABOVE character. To obtain correct results for locale insensitive strings, use toUpperCase(Locale.ROOT).

        Returns:
        the CharSeq, capitalized.

      • trim

        public CharSeq trim()
        Returns a string whose value is this string, with any leading and trailing whitespace removed.

        If this CharSeq object represents an empty character sequence, or the first and last characters of character sequence represented by this CharSeq object both have codes greater than '\u0020' (the space character), then a reference to this CharSeq object is returned.

        Otherwise, if there is no character with a code greater than '\u0020' in the string, then a CharSeq object representing an empty string is returned.

        Otherwise, let k be the index of the first character in the string whose code is greater than '\u0020', and let m be the index of the last character in the string whose code is greater than '\u0020'. A CharSeq object is returned, representing the substring of this string that begins with the character at index k and ends with the character at index m-that is, the result of this.substring(k, m + 1).

        This method may be used to trim whitespace (as defined above) from the beginning and end of a string.

        Returns:
        A string whose value is this string, with any leading and trailing white space removed, or this string if it has no leading or trailing white space.

      • toCharArray

        public char[] toCharArray()
        Converts this string to a new character array.
        Returns:
        a newly allocated character array whose length is the length of this string and whose contents are initialized to contain the character sequence represented by this string.

      • decodeByte

        public java.lang.Byte decodeByte()
        Decodes this CharSeq into a Byte by calling Byte.decode(String).

        We write 

        
 Byte value = charSeq.decodeByte();
        instead of 
        
 Byte value = Byte.decode(charSeq.mkString());
        Returns:
        a Byte object holding the byte value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - if this CharSeq does not contain a parsable byte.

      • decodeInteger

        public java.lang.Integer decodeInteger()
        Decodes this CharSeq into an Integer by calling Integer.decode(String).

        We write 

        
 Integer value = charSeq.decodeInteger();
        instead of 
        
 Integer value = Integer.decode(charSeq.mkString());
        Returns:
        an Integer object holding the int value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - if this CharSeq does not contain a parsable int.

      • decodeLong

        public java.lang.Long decodeLong()
        Decodes this CharSeq into a Long by calling Long.decode(String).

        We write 

        
 Long value = charSeq.decodeLong();
        instead of 
        
 Long value = Long.decode(charSeq.mkString());
        Returns:
        a Long object holding the long value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - if this CharSeq does not contain a parsable long.

      • decodeShort

        public java.lang.Short decodeShort()
        Decodes this CharSeq into a Short by calling Short.decode(String).

        We write 

        
 Short value = charSeq.decodeShort();
        instead of 
        
 Short value = Short.decode(charSeq.mkString());
        Returns:
        a Short object holding the short value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - if this CharSeq does not contain a parsable short.

      • parseBoolean

        public boolean parseBoolean()
        Parses this CharSeq as a boolean by calling Boolean.parseBoolean(String).

        We write 

        
 boolean value = charSeq.parseBoolean();
        instead of 
        
 boolean value = Boolean.parseBoolean(charSeq.mkString());
        Returns:
        the boolean represented by this CharSeq

      • parseByte

        public byte parseByte()
        Parses this CharSeq as a signed decimal byte by calling Byte.parseByte(String).

        We write 

        
 byte value = charSeq.parseByte();
        instead of 
        
 byte value = Byte.parseByte(charSeq.mkString());
        Returns:
        the byte value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable byte.

      • parseByte

        public byte parseByte​(int radix)
        Parses this CharSeq as a signed byte in the specified radix by calling Byte.parseByte(String, int).

        We write 

        
 byte value = charSeq.parseByte(radix);
        instead of 
        
 byte value = Byte.parseByte(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the byte value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable byte.

      • parseDouble

        public double parseDouble()
        Parses this CharSeq as a double by calling Double.parseDouble(String).

        We write 

        
 double value = charSeq.parseDouble();
        instead of 
        
 double value = Double.parseDouble(charSeq.mkString());
        Returns:
        the double value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable double.

      • parseFloat

        public float parseFloat()
        Parses this CharSeq as a float by calling Float.parseFloat(String).

        We write 

        
 float value = charSeq.parseFloat();
        instead of 
        
 float value = Double.parseFloat(charSeq.mkString());
        Returns:
        the float value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable float.

      • parseInt

        public int parseInt()
        Parses this CharSeq as a signed decimal int by calling Integer.parseInt(String).

        We write 

        
 int value = charSeq.parseInt();
        instead of 
        
 int value = Integer.parseInt(charSeq.mkString());
        Returns:
        the int value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable int.

      • parseInt

        public int parseInt​(int radix)
        Parses this CharSeq as a signed int in the specified radix by calling Integer.parseInt(String, int).

        We write 

        
 int value = charSeq.parseInt(radix);
        instead of 
        
 int value = Integer.parseInt(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the int value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable int.

      • parseUnsignedInt

        @GwtIncompatible
public int parseUnsignedInt()
        Parses this CharSeq as a unsigned decimal int by calling Integer.parseUnsignedInt(String).

        We write 

        
 int value = charSeq.parseUnsignedInt();
        instead of 
        
 int value = Integer.parseUnsignedInt(charSeq.mkString());
        Returns:
        the unsigned int value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable unsigned int.

      • parseUnsignedInt

        @GwtIncompatible
public int parseUnsignedInt​(int radix)
        Parses this CharSeq as a unsigned int in the specified radix by calling Integer.parseUnsignedInt(String, int).

        We write 

        
 int value = charSeq.parseUnsignedInt(radix);
        instead of 
        
 int value = Integer.parseUnsignedInt(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the unsigned int value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable unsigned int.

      • parseLong

        public long parseLong()
        Parses this CharSeq as a signed decimal long by calling Long.parseLong(String).

        We write 

        
 long value = charSeq.parseLong();
        instead of 
        
 long value = Long.parseLong(charSeq.mkString());
        Returns:
        the long value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable long.

      • parseLong

        public long parseLong​(int radix)
        Parses this CharSeq as a signed long in the specified radix by calling Long.parseLong(String, int).

        We write 

        
 long value = charSeq.parseLong(radix);
        instead of 
        
 long value = Long.parseLong(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the long value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable long.

      • parseUnsignedLong

        @GwtIncompatible
public long parseUnsignedLong()
        Parses this CharSeq as a unsigned decimal long by calling Long.parseUnsignedLong(String).

        We write 

        
 long value = charSeq.parseUnsignedLong();
        instead of 
        
 long value = Long.parseUnsignedLong(charSeq.mkString());
        Returns:
        the unsigned long value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable unsigned long.

      • parseUnsignedLong

        @GwtIncompatible
public long parseUnsignedLong​(int radix)
        Parses this CharSeq as a unsigned long in the specified radix by calling Long.parseUnsignedLong(String, int).

        We write 

        
 long value = charSeq.parseUnsignedLong(radix);
        instead of 
        
 long value = Long.parseUnsignedLong(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the unsigned long value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable unsigned long.

      • parseShort

        public short parseShort()
        Parses this CharSeq as a signed decimal short by calling Short.parseShort(String).

        We write 

        
 short value = charSeq.parseShort();
        instead of 
        
 short value = Short.parseShort(charSeq.mkString());
        Returns:
        the short value represented by this CharSeq in decimal
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable short.

      • parseShort

        public short parseShort​(int radix)
        Parses this CharSeq as a signed short in the specified radix by calling Short.parseShort(String, int).

        We write 

        
 short value = charSeq.parseShort(radix);
        instead of 
        
 short value = Short.parseShort(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this CharSeq
        Returns:
        the short value represented by this CharSeq in the specified radix
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable short.

      • toBoolean

        public java.lang.Boolean toBoolean()
        Converts this CharSeq to a Boolean by calling Boolean.valueOf(String).

        We write 

        
 Boolean value = charSeq.toBoolean();
        instead of 
        
 Boolean value = Boolean.valueOf(charSeq.mkString());
        Returns:
        the Boolean value represented by this CharSeq

      • toByte

        public java.lang.Byte toByte()
        Converts this CharSeq to a Byte by calling Byte.valueOf(String).

        We write 

        
 Byte value = charSeq.toByte();
        instead of 
        
 Byte value = Byte.valueOf(charSeq.mkString());
        Returns:
        a Byte object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable byte.

      • toByte

        public java.lang.Byte toByte​(int radix)
        Converts this CharSeq to a Byte in the specified radix by calling Byte.valueOf(String, int).

        We write 

        
 Byte value = charSeq.toByte(radix);
        instead of 
        
 Byte value = Byte.valueOf(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this char sequence
        Returns:
        a Byte object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable byte.

      • toDouble

        public java.lang.Double toDouble()
        Converts this CharSeq to a Double by calling Double.valueOf(String).

        We write 

        
 Double value = charSeq.toDouble();
        instead of 
        
 Double value = Double.valueOf(charSeq.mkString());
        Returns:
        a Double object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable double.

      • toFloat

        public java.lang.Float toFloat()
        Converts this CharSeq to a Float by calling Float.valueOf(String).

        We write 

        
 Float value = charSeq.toFloat();
        instead of 
        
 Float value = Float.valueOf(charSeq.mkString());
        Returns:
        a Float object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable float.

      • toInteger

        public java.lang.Integer toInteger()
        Converts this CharSeq to an Integer by calling Integer.valueOf(String).

        We write 

        
 Integer value = charSeq.toInteger();
        instead of 
        
 Integer value = Integer.valueOf(charSeq.mkString());
        Returns:
        an Integer object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable int.

      • toInteger

        public java.lang.Integer toInteger​(int radix)
        Converts this CharSeq to an Integer in the specified radix by calling Integer.valueOf(String, int).

        We write 

        
 Integer value = charSeq.toInteger(radix);
        instead of 
        
 Integer value = Integer.valueOf(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this char sequence
        Returns:
        an Integer object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable int.

      • toLong

        public java.lang.Long toLong()
        Converts this CharSeq to a Long by calling Long.valueOf(String).

        We write 

        
 Long value = charSeq.toLong();
        instead of 
        
 Long value = Long.valueOf(charSeq.mkString());
        Returns:
        a Long object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable long.

      • toLong

        public java.lang.Long toLong​(int radix)
        Converts this CharSeq to a Long in the specified radix by calling Long.valueOf(String, int).

        We write 

        
 Long value = charSeq.toLong(radix);
        instead of 
        
 Long value = Long.valueOf(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this char sequence
        Returns:
        a Long object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable long.

      • toShort

        public java.lang.Short toShort()
        Converts this CharSeq to a Short by calling Short.valueOf(String).

        We write 

        
 Short value = charSeq.toShort();
        instead of 
        
 Short value = Short.valueOf(charSeq.mkString());
        Returns:
        a Short object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable short.

      • toShort

        public java.lang.Short toShort​(int radix)
        Converts this CharSeq to a Short in the specified radix by calling Short.valueOf(String, int).

        We write 

        
 Short value = charSeq.toShort(radix);
        instead of 
        
 Short value = Short.valueOf(charSeq.mkString(), radix);
        Parameters:
        radix - the radix to be used in interpreting this char sequence
        Returns:
        a Short object holding the value represented by this CharSeq
        Throws:
        java.lang.NumberFormatException - If this CharSeq does not contain a parsable short.

      • toJavaArray

        public java.lang.Character[] toJavaArray()
        Description copied from interface: Value
        Converts this to a Java array with component type Object 
        
 // = [] of type Object[]
 Future.<String> of(() -> { throw new Error(); })
       .toJavaArray()

 // = [ok] of type Object[]
 Try.of(() -> "ok")
    .toJavaArray()

 // = [1, 2, 3] of type Object[]
 List.of(1, 2, 3)
     .toJavaArray()
        Specified by:
        toJavaArray in interface Value<java.lang.Character>
        Returns:
        A new Java array.