概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## ts.util
クラス CountUp

    java.lang.Object
      ts.util.CountUp

    public class CountUp

extends java.lang.Object

カウントアップクラス。
カウンタの値を保持し、それを一つずつ加算していくためのメソッドを 用意している。 カウンタの初期値及び上限値は、デフォルトではそれぞれゼロ及び `Long.MAX_VALUE` に設定されるが、コンストラクタで指定する こともできる。
このクラスの直接のインスタンスはマルチスレッドに対応していないが、 `synchronizedCountUp()`メソッドを使用して、 スレッドセーフなインスタンスを作成することができる。

バージョン:
  $Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:43 $
作成者:
  佐藤隆之.

コンストラクタの概要
`CountUp()` デフォルトコンストラクタ。
`CountUp(long limit)` カウンタの上限値を引数にとるコンストラクタ。
`CountUp(long init, long limit)` カウンタの初期値と上限値を引数にとるコンストラクタ。

メソッドの概要
`long` | `currentValue()` 現在のカウンタ値を取得する。
`long` | `increment()` カウンタを一つ加算する。
`boolean` | `isReached()` カウンタの値が上限値に達したかどうかを判定する。
`long` | `limitValue()` 上限値を取得する。
`static CountUp` | `synchronizedCountUp()` スレッドセーフなカウントアップオブジェクトを生成する。
`static CountUp` | `synchronizedCountUp(CountUp c)` 指定されたカウントアップオブジェクトの現在の値を使用して、 スレッドセーフなカウントアップオブジェクトを新たに生成する。
`static CountUp` | `synchronizedCountUp(long limit)` カウンタの上限値を指定して、スレッドセーフなカウントアップオブジェクト を生成する。
`static CountUp` | `synchronizedCountUp(long init, long limit)` カウンタの初期値と上限値を指定して、スレッドセーフなカウントアップ オブジェクトを生成する。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### CountUp

    public CountUp()

  デフォルトコンストラクタ。
  カウンタの初期値はゼロ、上限値は`Long.MAX_VALUE`とする。

### CountUp

    public CountUp(long limit)

  カウンタの上限値を引数にとるコンストラクタ。
  カウンタの初期値はゼロとする。カウンタの上限値がゼロよりも小さい場合も、 そのまま設定する。

  パラメータ:
    `limit` - カウンタの上限値。

### CountUp

    public CountUp(long init,
                   long limit)

  カウンタの初期値と上限値を引数にとるコンストラクタ。
  初期値が上限値よりも大きい場合も、そのまま設定する。

  パラメータ:
    `init` - カウンタの初期値。
    `limit` - カウンタの上限値。

メソッドの詳細

### currentValue

    public long currentValue()

  現在のカウンタ値を取得する。

  戻り値:
    現在のカウンタ値。

### limitValue

    public long limitValue()

  上限値を取得する。

  戻り値:
    上限値。

### isReached

    public boolean isReached()

  カウンタの値が上限値に達したかどうかを判定する。

  戻り値:
    カウンタの値が上限値よりも大きいか等しい場合は`true`を返 し、そうでなければ`false`を返す。

### increment

    public long increment()
                   throws OutOfRangeException

  カウンタを一つ加算する。
  カウンタの値が上限値を越える場合には例外をスローする。

  戻り値:
    加算後のカウンタ値。
  例外:
    `OutOfRangeException` - カウンタが上限値を越える場合。

### synchronizedCountUp

    public static CountUp synchronizedCountUp()

  スレッドセーフなカウントアップオブジェクトを生成する。
  カウンタの初期値はゼロ、上限値は`Long.MAX_VALUE`とする。

  戻り値:
    スレッドセーフなカウントアップオブジェクト。

### synchronizedCountUp

    public static CountUp synchronizedCountUp(long limit)

  カウンタの上限値を指定して、スレッドセーフなカウントアップオブジェクト を生成する。
  カウンタの初期値はゼロとする。カウンタの上限値がゼロよりも小さい場合も、 そのまま設定する。

  パラメータ:
    `limit` - カウンタの上限値。
  戻り値:
    スレッドセーフなカウントアップオブジェクト。

### synchronizedCountUp

    public static CountUp synchronizedCountUp(long init,
                                              long limit)

  カウンタの初期値と上限値を指定して、スレッドセーフなカウントアップ オブジェクトを生成する。
  初期値が上限値よりも大きい場合も、そのまま設定する。

  パラメータ:
    `init` - カウンタの初期値。
    `limit` - カウンタの上限値。
  戻り値:
    スレッドセーフなカウントアップオブジェクト。

### synchronizedCountUp

    public static CountUp synchronizedCountUp(CountUp c)

  指定されたカウントアップオブジェクトの現在の値を使用して、 スレッドセーフなカウントアップオブジェクトを新たに生成する。

  パラメータ:
    `c` - 元になるカウントアップオブジェクト。
  戻り値:
    スレッドセーフなカウントアップオブジェクト。
  例外:
    `java.lang.AssertionError` - 引数がヌルの場合（デバッグモードのみ）。

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright (C) SATOH Takayuki All Rights Reserved.