de.caff.util

## Class StringCodePointIterator

- java.lang.Object
- - de.caff.util.StringCodePointIterator

- Direct Known Subclasses:
    IntegerStringCharacterIterator

      public class StringCodePointIterator
      extends java.lang.Object

  A simplified drop in for `java.text.StringCharacterIterator` which takes care of 32bit characters. It iterates over the strings by codepoints, not characters.
  Author:
    Rammi

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `DONE` Value return when iteration is done.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StringCodePointIterator(java.lang.String str)` Constructor.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `current()` Get the current character.
    `int` | `first()` Get the first character.
    `int` | `next()` Step to next character.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### DONE

          public static final int DONE

      Value return when iteration is done.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### StringCodePointIterator

          public StringCodePointIterator(@NotNull
                                         java.lang.String str)

      Constructor.
      Parameters:
        `str` - string to iterate over

  - ### Method Detail

    - #### first

          public int first()

      Get the first character.
      Returns:
        first character

    - #### current

          public int current()

      Get the current character.
      Returns:
        current 32bit Unicode character

    - #### next

          public int next()

      Step to next character.
      Returns:
        next character