org.maachang.rimdb.index.string

## クラス IString

- java.lang.Object
- - org.maachang.rimdb.index.string.IString

- すべての実装されたインタフェース:
    java.lang.Comparable<IString>

      public final class IString
      extends java.lang.Object
      implements java.lang.Comparable<IString>

  インデックス用文字情報.
  導入されたバージョン:
    rimdb-1.00
  バージョン:
    2014/07/04
  作成者:
    masahito suzuki

- - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `IString()` コンストラクタ.
    `IString(char[] v)` コンストラクタ.
    `IString(java.lang.String v)` コンストラクタ.

  - ### メソッドのサマリー

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `compareTo(IString n)` 比較.
    `boolean` | `endsWith(char[] n)` 終端一致チェック.
    `boolean` | `endsWith(IString n)` 終端一致チェック.
    `boolean` | `endsWith(java.lang.String n)` 終端一致チェック.
    `boolean` | `equals(int off, IString o, int oOff, int len)` 同一チェック.
    `boolean` | `equals(java.lang.Object o)` 同一チェック.
    `char[]` | `getChars()` 現在のキャラクタ配列を返却.
    `int` | `indexOf(char[] n, int off)` indexof.
    `int` | `indexOf(IString n, int off)` indexof.
    `int` | `indexOf(java.lang.String n, int off)` indexof.
    `boolean` | `isEmpty()` 情報が存在しないかチェック.
    `int` | `length()` 長さを取得.
    `boolean` | `startsWith(char[] n)` 開始一致チェック.
    `boolean` | `startsWith(IString n)` 開始一致チェック.
    `boolean` | `startsWith(java.lang.String n)` 開始一致チェック.
    `IString` | `subIString(int s)` substring.
    `IString` | `subIString(int s, int e)` substring.
    `java.lang.String` | `substring(int s)` substring.
    `java.lang.String` | `substring(int s, int e)` substring.
    `int` | `toBig(IString n)` このオブジェクトの方が大きいかチェック.
    `java.lang.String` | `toString()` 文字列化.

    - ### クラスから継承されたメソッド java.lang.Object

      `getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### IString

          public IString()

      コンストラクタ. ゼロ文字を表すオブジェクトを生成.

    - #### IString

          public IString(char[] v)

      コンストラクタ.
      パラメータ:
        `v` - 対象のキャラクタを設定.

    - #### IString

          public IString(java.lang.String v)

      コンストラクタ.
      パラメータ:
        `v` - 対象の文字を設定.

  - ### メソッドの詳細

    - #### isEmpty

          public final boolean isEmpty()

      情報が存在しないかチェック.
      戻り値:
        boolean [true]の場合、空です.

    - #### equals

          public final boolean equals(java.lang.Object o)

      同一チェック.
      オーバーライド:
        `equals` クラス内 `java.lang.Object`
      パラメータ:
        `o` - チェック対象を設定します.
      戻り値:
        boolean [true]の場合、一致しています.

    - #### equals

          public final boolean equals(int off,
                       IString o,
                       int oOff,
                       int len)

      同一チェック.
      パラメータ:
        `off` - チェック元の文字オフセット値を設定します.
        `o` - チェック先の文字を設定します.
        `oOff` - チェック先の文字オフセット値を設定します.
        `len` - チェック先の文字長を設定します.
      戻り値:
        boolean [true]の場合、一致しています.

    - #### compareTo

          public final int compareTo(IString n)

      比較.
      定義:
        `compareTo` インタフェース内 `java.lang.Comparable<IString>`
      パラメータ:
        `n` - 比較先の情報を設定します.
      戻り値:
        int 0以上の場合、比較元が大きい. 0以下の場合、比較先が大きい. 0の場合は同一.

    - #### toBig

          public final int toBig(IString n)

      このオブジェクトの方が大きいかチェック. compareToと違うのは、文字比較が同一の場合、元の長さではチェックしない. つまり、abcd と abc を比較した場合、同一とみなすと言うこと。
      パラメータ:
        `n` - 比較先の情報を設定します.
      戻り値:
        int 0以上の場合、比較元が大きい. 0以下の場合、比較先が大きい. 0の場合は同一.

    - #### indexOf

          public final int indexOf(java.lang.String n,
                    int off)

      indexof.
      パラメータ:
        `n` - 対象の文字を設定します.
        `off` - オフセット値を設定します.
      戻り値:
        int 一致場所が返却される.-1の場合は存在しない.

    - #### indexOf

          public final int indexOf(char[] n,
                    int off)

      indexof.
      パラメータ:
        `n` - 対象の文字を設定します.
        `off` - オフセット値を設定します.
      戻り値:
        int 一致場所が返却される.-1の場合は存在しない.

    - #### indexOf

          public final int indexOf(IString n,
                    int off)

      indexof.
      パラメータ:
        `n` - 対象の文字を設定します.
        `off` - オフセット値を設定します.
      戻り値:
        int 一致場所が返却される.-1の場合は存在しない.

    - #### startsWith

          public final boolean startsWith(java.lang.String n)

      開始一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、開始条件が一致しています.

    - #### startsWith

          public final boolean startsWith(char[] n)

      開始一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、開始条件が一致しています.

    - #### startsWith

          public final boolean startsWith(IString n)

      開始一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、開始条件が一致しています.

    - #### endsWith

          public final boolean endsWith(java.lang.String n)

      終端一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、終端条件が一致しています.

    - #### endsWith

          public final boolean endsWith(char[] n)

      終端一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、終端条件が一致しています.

    - #### endsWith

          public final boolean endsWith(IString n)

      終端一致チェック.
      パラメータ:
        `n` - 対象の文字を設定します.
      戻り値:
        boolean [true]の場合、終端条件が一致しています.

    - #### length

          public final int length()

      長さを取得.
      戻り値:
        int 文字列長が返却されます.

    - #### getChars

          public final char[] getChars()

      現在のキャラクタ配列を返却.
      戻り値:
        char[] char配列が返却されます.

    - #### substring

          public final java.lang.String substring(int s,
                                   int e)

      substring.
      パラメータ:
        `s` - 開始位置を設定します.
        `e` - 終了位置を設定します.
      戻り値:
        String substringされた文字が返却されます.

    - #### substring

          public final java.lang.String substring(int s)

      substring.
      パラメータ:
        `s` - 開始位置を設定します.
      戻り値:
        String substringされた文字が返却されます.

    - #### subIString

          public final IString subIString(int s,
                           int e)

      substring.
      パラメータ:
        `s` - 開始位置を設定します.
        `e` - 終了位置を設定します.
      戻り値:
        IString substringされた文字が返却されます.

    - #### subIString

          public final IString subIString(int s)

      substring.
      パラメータ:
        `s` - 開始位置を設定します.
      戻り値:
        IString substringされた文字が返却されます.

    - #### toString

          public final java.lang.String toString()

      文字列化.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        String 文字列が返却されます.