kinugasa.util
クラス SequentialIndex

java.lang.Object
  上位を拡張 kinugasa.object.Model
      上位を拡張 kinugasa.util.ArrayIndexModel
          上位を拡張 kinugasa.util.SequentialIndex
すべての実装されたインタフェース:
java.io.Serializable, java.lang.Cloneable

public class SequentialIndex
extends ArrayIndexModel

Kinugasa : SequentialIndex : 配列の要素に、順番にアクセスする基本的なインデックスのカウンタです.
インデックスは、昇順、降順の切り替えが可能です。ループするかどうかも選択できます。
indexメソッドが呼び出されるたびに、インデックスの値がカウントされます。

この実装は、内部でカウンタの値を保持するため、1つの配列要素に対して、1つの インデックスモデルが必要です。

バージョン:
1.0.0 - 2013/01/12_17:12:36
作成者:
Dra0211
関連項目:
直列化された形式

フィールドの概要
private  int index
          現在のインデックスです.
private  boolean loop
          インデックスをループするかどうかのフラグです.
private static long serialVersionUID
           
private  boolean toPlus
          インデックスを+の方向に進めるかどうかのフラグです.
 
コンストラクタの概要
SequentialIndex()
          0からスタートし、右方向へループするインデックスモデルを作成します.
SequentialIndex(boolean loop)
          0からスタートし、右方向へ進むインデックスモデルを作成します.
SequentialIndex(boolean loop, boolean toPlus)
          0からスタートし、指定された方向へ進むインデックスモデルを作成します.
SequentialIndex(int index)
          指定されたインデックスからスタートし、右方向へループするインデックスモデルを作成します.
SequentialIndex(int index, boolean loop)
          指定されたインデックスからスタートし、右方向へループするインデックスモデルを作成します.
SequentialIndex(int index, boolean loop, boolean toPlus)
          指定されたインデックスからスタートするインデックスモデルを作成します.
 
メソッドの概要
 ArrayIndexModel clone()
          このモデルのクローンを返します.
 boolean equals(java.lang.Object obj)
           
 int getIndex()
          現在のインデックスを返します.
 int hashCode()
           
 int index(int arrayLength)
          特定のアルゴリズムにしたがって、配列のインデックスを返します.
 boolean isLoop()
          このインデックスモデルがループするかを調べます.
 boolean isToPlus()
          このインデックスモデルのインデックスの進む方向を調べます.
 void setIndex(int index)
          インデックスの現在値を設定します.
 void setLoop(boolean loop)
          ループする設定を変更します.
 void setToPlus(boolean toPlus)
          インデックスの進む方向を変更します.
 java.lang.String toString()
           
 
クラス kinugasa.object.Model から継承されたメソッド
clone
 
クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
関連項目:
定数フィールド値

index

private int index
現在のインデックスです.


loop

private boolean loop
インデックスをループするかどうかのフラグです.


toPlus

private boolean toPlus
インデックスを+の方向に進めるかどうかのフラグです.

コンストラクタの詳細

SequentialIndex

public SequentialIndex()
0からスタートし、右方向へループするインデックスモデルを作成します.


SequentialIndex

public SequentialIndex(int index)
指定されたインデックスからスタートし、右方向へループするインデックスモデルを作成します.

パラメータ:
index - インデックスの初期値を指定します。

SequentialIndex

public SequentialIndex(boolean loop)
0からスタートし、右方向へ進むインデックスモデルを作成します.

パラメータ:
loop - trueを指定すると、インデックスが配列の最後の要素を参照するとき 次の参照では0番目に戻ります。
falseでは、最後の参照でインデックスの更新が止まります。

SequentialIndex

public SequentialIndex(boolean loop,
                       boolean toPlus)
0からスタートし、指定された方向へ進むインデックスモデルを作成します.

パラメータ:
loop - trueを指定すると、インデックスが配列の最後の要素を参照するとき 次の参照では0番目に戻ります。
falseでは、最後の参照でインデックスの更新が止まります。
toPlus - trueを指定すると、インデックスは+の方向へ進みます。
falseでは-の方向へ進みます。

SequentialIndex

public SequentialIndex(int index,
                       boolean loop)
指定されたインデックスからスタートし、右方向へループするインデックスモデルを作成します.

パラメータ:
index - インデックスの初期値を指定します。
loop - trueを指定すると、インデックスが配列の最後の要素を参照するとき 次の参照では0番目に戻ります。
falseでは、最後の参照でインデックスの更新が止まります。

SequentialIndex

public SequentialIndex(int index,
                       boolean loop,
                       boolean toPlus)
指定されたインデックスからスタートするインデックスモデルを作成します.

パラメータ:
index - インデックスの初期値を指定します。
loop - trueを指定すると、インデックスが配列の最後の要素を参照するとき 次の参照では0番目に戻ります。
falseでは、最後の参照でインデックスの更新が止まります。
toPlus - trueを指定すると、インデックスは+の方向へ進みます。
falseでは-の方向へ進みます。
メソッドの詳細

index

public int index(int arrayLength)
クラス ArrayIndexModel の記述:
特定のアルゴリズムにしたがって、配列のインデックスを返します. このメソッドでは、インデックスの遷移を自動で行います。
したがって、次の呼び出しではアルゴリズムに沿った 「次の値」を返します。

定義:
クラス ArrayIndexModel 内の index
パラメータ:
arrayLength - 配列の長さ(length)を送信します。
戻り値:
配列のインデックスを返します。インデックスは0からarrayLength-1である必要があります。

setIndex

public void setIndex(int index)
インデックスの現在値を設定します.

パラメータ:
index - カウンタの値を指定します。

getIndex

public int getIndex()
クラス ArrayIndexModel の記述:
現在のインデックスを返します. このメソッドでは、インデックスを変更せずに、現在値を返します。

定義:
クラス ArrayIndexModel 内の getIndex
戻り値:
インデックスの現在値を返します。

setLoop

public void setLoop(boolean loop)
ループする設定を変更します.

パラメータ:
loop - trueを指定すると、インデックスが配列の最後の要素を参照するとき 次の参照では0番目に戻ります。
falseでは、最後の参照でインデックスの更新が止まります。

isLoop

public boolean isLoop()
このインデックスモデルがループするかを調べます.

戻り値:
ループする設定では、trueを返します。

setToPlus

public void setToPlus(boolean toPlus)
インデックスの進む方向を変更します.

パラメータ:
toPlus - trueを指定すると、インデックスは+の方向へ進みます。
falseでは-の方向へ進みます。

isToPlus

public boolean isToPlus()
このインデックスモデルのインデックスの進む方向を調べます.

戻り値:
trueでは、インデックスは+の方向へ進みます。

clone

public ArrayIndexModel clone()
クラス Model の記述:
このモデルのクローンを返します. クローンはObjectクラスの機能を使って行われます。
全てのモデルの実装は、cloneメソッドを適切にオーバーライドする必要があります。

オーバーライド:
クラス ArrayIndexModel 内の clone
戻り値:
このモデルと同じクラスの新しいインスタンスを返します。

hashCode

public int hashCode()
オーバーライド:
クラス java.lang.Object 内の hashCode

equals

public boolean equals(java.lang.Object obj)
オーバーライド:
クラス java.lang.Object 内の equals

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString