ts.util
クラス CountDown

java.lang.Object
  上位を拡張 ts.util.CountDown

public class CountDown
extends java.lang.Object

カウントダウンクラス。
カウンタの値を保持し、それを一つずつ減算していくためのメソッドを 用意している。 カウンタの下限値は、デフォルトではゼロに設定されるが、コンストラクタで指定 することもできる。 カウンタの初期値は必ずコンストラクタで指定しなければならない。
このクラスの直接のインスタンスはマルチスレッドに対応していないが、 synchronizedCountDown(long)メソッドを利用して、 スレッドセーフなインスタンスを生成することができる。

バージョン:
$Revision: 1.2 $, $Date: 2007/02/15 15:28:02 $
作成者:
佐藤隆之.

コンストラクタの概要
CountDown(long init)
          カウンタの初期値を引数にとるコンストラクタ。
CountDown(long init, long limit)
          カウンタの初期値と下限値を引数にとるコンストラクタ。
 
メソッドの概要
 long currentValue()
          現在のカウンタ値を取得する。
 long decrement()
          カウンタを一つ減算する。
 boolean isReached()
          カウンタの値が下限値に達したかどうかを判定する。
 long limitValue()
          下限値を取得する。
static CountDown synchronizedCountDown(CountDown c)
          指定されたカウントダウンオブジェクトの現在の値を使用して、 スレッドセーフなカウントダウンオブジェクトを新たに生成する。
static CountDown synchronizedCountDown(long init)
          カウンタの初期値を指定して、スレッドセーフなカウントダウンオブジェクト を生成する。
static CountDown synchronizedCountDown(long init, long limit)
          カウンタの初期値及び下限値を指定して、スレッドセーフなカウントアップ オブジェクトを生成する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CountDown

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


CountDown

public CountDown(long init,
                 long limit)
カウンタの初期値と下限値を引数にとるコンストラクタ。
初期値が下限値よりも小さい場合も、そのまま設定する。

パラメータ:
init - カウンタの初期値。
limit - カウンタの下限値。
メソッドの詳細

currentValue

public long currentValue()
現在のカウンタ値を取得する。

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

limitValue

public long limitValue()
下限値を取得する。

戻り値:
下限値。

isReached

public boolean isReached()
カウンタの値が下限値に達したかどうかを判定する。

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

decrement

public long decrement()
               throws OutOfRangeException
カウンタを一つ減算する。
カウンタの値が下限値を越える場合には例外をスローする。

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

synchronizedCountDown

public static CountDown synchronizedCountDown(long init)
カウンタの初期値を指定して、スレッドセーフなカウントダウンオブジェクト を生成する。
カウンタの下限値はゼロとする。

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

synchronizedCountDown

public static CountDown synchronizedCountDown(long init,
                                              long limit)
カウンタの初期値及び下限値を指定して、スレッドセーフなカウントアップ オブジェクトを生成する。
初期値が下限値よりも小さい場合も、そのまま設定する。

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

synchronizedCountDown

public static CountDown synchronizedCountDown(CountDown c)
指定されたカウントダウンオブジェクトの現在の値を使用して、 スレッドセーフなカウントダウンオブジェクトを新たに生成する。

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


Copyright (C) SATOH Takayuki All Rights Reserved.