モジュール java.base
パッケージ java.util.concurrent

クラスSemaphore

  • すべての実装じっそうされたインタフェース:
    Serializable

    public class Semaphore
extends Object
implements Serializable
    計数けいすうセマフォです。 概念的がいねんてきに、セマフォはパーミットのセットを維持いじします。 各かくacquire()は、パーミットが利用りよう可能かのうになるまで必要ひつように応おうじてブロックし、その後ごパーミットを取得しゅとくします。 各かくrelease()はパーミットを追加ついかし、場合ばあいによってはブロックしている取得しゅとく側がわを解放かいほうします。 ただし、実際じっさいのパーミット・オブジェクトは使用しようされません。Semaphoreは単たんに利用りよう可能かのうな個数こすうのカウントを保持ほじし、それに応おうじた処理しょりを行おこないます。

    セマフォは、物理ぶつり的てきまたは論理ろんり的てきな一部いちぶのリソースにアクセス可能かのうなスレッド数すうを制限せいげんするためによく使用しようされます。 たとえば、次つぎのクラスでは、セマフォを使用しようして項目こうもくのプールへのアクセスを制御せいぎょします。 

     
 class Pool {
   private static final int MAX_AVAILABLE = 100;
   private final Semaphore available = new Semaphore(MAX_AVAILABLE, true);

   public Object getItem() throws InterruptedException {
     available.acquire();
     return getNextAvailableItem();
   }

   public void putItem(Object x) {
     if (markAsUnused(x))
       available.release();
   }

   // Not a particularly efficient data structure; just for demo

   protected Object[] items = ... whatever kinds of items being managed
   protected boolean[] used = new boolean[MAX_AVAILABLE];

   protected synchronized Object getNextAvailableItem() {
     for (int i = 0; i < MAX_AVAILABLE; ++i) {
       if (!used[i]) {
         used[i] = true;
         return items[i];
       }
     }
     return null; // not reached
   }

   protected synchronized boolean markAsUnused(Object item) {
     for (int i = 0; i < MAX_AVAILABLE; ++i) {
       if (item == items[i]) {
         if (used[i]) {
           used[i] = false;
           return true;
         } else
           return false;
       }
     }
     return false;
   }
 }

    項目こうもくを取得しゅとくする前まえに、各かくスレッドはセマフォから、項目こうもくが利用りよう可能かのうであることを保証ほしょうするパーミットを取得しゅとくする必要ひつようがあります。 項目こうもくの処理しょりが完了かんりょうするとスレッドはプールに戻もどり、パーミットがセマフォに返かえされ、ほかのスレッドがその項目こうもくを取得しゅとくできるようになります。 acquire()が呼よび出だされたとき、同期どうきロックは保持ほじされないことに注意ちゅういしてください。同期どうきロックが保持ほじされると、項目こうもくがプールに返かえされなくなるためです。 セマフォは、プールへのアクセスを制限せいげんする必要ひつようのある同期どうきを、プール自体じたいの一貫いっかん性せいを維持いじするために必要ひつような同期どうきからは分離ぶんりしてカプセル化かします。

    値ねを1に初期しょき化かされたセマフォは、利用りようできるパーミットが最大さいだいで1個いっこであるセマフォとして使用しようされるため、相互そうご排他はいたロックとして利用りようできます。 これは一般いっぱん的てきには2進しん型がたセマフォと呼よばれます。利用りよう可能かのうなパーミットが1つか、または利用りよう可能かのうなパーミットがないかの2つの状態じょうたいしかないためです。 このように使用しようされた場合ばあい、多おおくのLock実装じっそうとは異ことなり、2進しん型がたセマフォには、所有しょゆう者しゃ以外いがいのスレッドでロックを解放かいほうできるという特性とくせいがあります(セマフォには所有しょゆう権けんの概念がいねんがないため)。 これは、デッドロックの回復かいふくのような特殊とくしゅなコンテキストで便利べんりです。

    このクラスのコンストラクタは、オプションで公平こうへい性せいパラメータを受うけ入いれます。 falseに設定せっていすると、このクラスはスレッドがパーミットを取得しゅとくする順序じゅんじょについて保証ほしょうしません。 特とくに、バージ(barging)が許可きょかされています。つまり、acquire()を呼よび出だすスレッドに、待機たいきしていたスレッドより先さきにパーミットを割わり当あてることができます。論理ろんり的てきには、新あたらしいスレッドが、待機たいき中ちゅうのスレッドのキューの先頭せんとうに配置はいちされます。 公平こうへい性せいがtrueに設定せっていされると、セマフォは、acquireメソッドのいずれかを呼よび出だすスレッドが、これらのメソッドの呼出よびだしが処理しょりされた順序じゅんじょ(先入さきいれ先出さきだし、FIFO)でパーミットを取得しゅとくするように選択せんたくされることを保証ほしょうします。 FIFO順序じゅんじょ付づけは、必然ひつぜん的てきにこれらのメソッド内ないの特定とくていの内部ないぶ実行じっこうポイントに適用てきようされます。 そのため、あるスレッドが別べつのスレッドより前まえにacquireを呼よび出だしても、そのスレッドよりあとに順序付じゅんじょづけポイントに到達とうたつする可能かのう性せいがあります。また、メソッドからの復帰ふっき時じも同様どうようです。 また、時間じかん指定していのないtryAcquireメソッドは公平こうへい性せいの設定せっていに従したがいませんが、利用りよう可能かのうなパーミットをすべて取得しゅとくすることにも注意ちゅういしてください。

    通常つうじょう、リソース・アクセスを制御せいぎょするために使用しようされるセマフォは、リソースへのアクセスができないスレッドがないよう、公平こうへいに初期しょき化かされる必要ひつようがあります。 ほかの種類しゅるいの同期どうき制御せいぎょにセマフォを使用しようする場合ばあいは、公平こうへい性せいを考慮こうりょするよりも不公平ふこうへいな順序じゅんじょ付づけによるスループットの利点りてんのほうがしばしば重要じゅうようになります。

    このクラスはまた、複数ふくすうのパーミットに対たいして同時どうじにacquireやreleaseを実行じっこうするための簡易かんいメソッドも提供ていきょうします。 これらのメソッドは一般いっぱんに、ループより効率こうりつ的てきかつ効果こうか的てきである。 ただし、優先ゆうせん順位じゅんいは設定せっていされません。 たとえば、スレッドAがs.acquire(3を呼よび出だし、スレッドBがs.acquire(2)を呼よび出だし、2つの許可きょかが利用りよう可能かのうになると、その獲得かくとくが最初さいしょに行おこなわれ、Semaphore sがフェア・モードでない限かぎり、スレッドBがそれらを取得しゅとくする保証ほしょうはありません。

    メモリー整合せいごう性せい効果こうか: release()などの「解放かいほう」メソッドを呼よび出だす前まえのスレッド内ないのアクションは、別べつのスレッド内ないのacquire()などの正常せいじょう終了しゅうりょうした「取得しゅとく」メソッドに続つづくアクションの前まえに発生はっせいします。

    導入どうにゅうされたバージョン:
    1.5
    関連かんれん項目こうもく:
    直列ちょくれつ化かされた形式けいしき

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

      コンストラクタ 
      コンストラクタ 説明せつめい
      Semaphore​(int permits)
      指定していされた数かずのパーミットと不公平ふこうへいな公平こうへい性せい設定せっていを使用しようして、Semaphoreを作成さくせいします。
      Semaphore​(int permits, boolean fair)
      指定していされた数かずのパーミットと指定していされた公平こうへい性せい設定せっていを使用しようして、Semaphoreを作成さくせいします。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象ぐしょうメソッド 
      修飾しゅうしょく子こと型かた メソッド 説明せつめい
      void acquire​()
      このセマフォからパーミットを取得しゅとくします。パーミットが利用りよう可能かのうになるか、またはスレッドが割わり込こみされるまでブロックします。
      void acquire​(int permits)
      このセマフォから指定していされた数かずのパーミットを取得しゅとくします。すべてのパーミットが利用りよう可能かのうになるか、またはスレッドが割わり込こみされるまでブロックします。
      void acquireUninterruptibly​()
      このセマフォからパーミットを取得しゅとくします。パーミットが利用りよう可能かのうになるまでブロックします。
      void acquireUninterruptibly​(int permits)
      このセマフォから指定していされた数かずのパーミットを取得しゅとくします。すべてのパーミットが利用りよう可能かのうになるまでブロックします。
      int availablePermits​()
      このセマフォで現在げんざい利用りよう可能かのうなパーミットの数かずを返かえします。
      int drainPermits​()
      すぐに利用りよう可能かのうなすべての許可きょかを取得しゅとくして返かえします。または、否定ひてい的てきな許可きょかが利用りよう可能かのうな場合ばあいは、それらを解放かいほうします。
      protected Collection<Thread> getQueuedThreads​()
      パーミットの取得しゅとくを待機たいきしているスレッドを含ふくむコレクションを返かえします。
      int getQueueLength​()
      パーミットの取得しゅとくを待機たいきしているスレッドの推定すいてい数すうを返かえします。
      boolean hasQueuedThreads​()
      パーミットの取得しゅとくを待機たいき中ちゅうのスレッドが存在そんざいするかどうかを照会しょうかいします。
      boolean isFair​()
      このセマフォで公平こうへい性せいがtrueに設定せっていされている場合ばあいはtrueを返かえします。
      protected void reducePermits​(int reduction)
      指定していされたreductionの数かずだけ利用りよう可能かのうなパーミットの数かずを減へらします。
      void release​()
      パーミットを解放かいほうし、セマフォに戻もどします。
      void release​(int permits)
      指定していされた数かずのパーミットを解放かいほうし、セマフォに戻もどします。
      String toString​()
      セマフォおよびその状態じょうたいを識別しきべつする文字もじ列れつを返かえします。
      boolean tryAcquire​()
      パーミットが呼出よびだし時じに利用りよう可能かのうな場合ばあいに限かぎり、このセマフォからパーミットを取得しゅとくします。
      boolean tryAcquire​(int permits)
      指定していされた数かずのパーミットが呼出よびだし時じに利用りよう可能かのうな場合ばあいに限かぎり、それらすべてのパーミットを取得しゅとくします。
      boolean tryAcquire​(int permits, long timeout, TimeUnit unit)
      指定していされた待機たいき時間じかん内ないで指定していされた数かずのパーミットが利用りよう可能かのうであり、現在げんざいのスレッドで割わり込こみが発生はっせいしていない場合ばあいに、このセマフォから指定していされた数かずのパーミットを取得しゅとくします。
      boolean tryAcquire​(long timeout, TimeUnit unit)
      指定していされた待機たいき時間じかん内ないでパーミットが利用りよう可能かのうになり、現在げんざいのスレッドで割わり込こみが発生はっせいしていない場合ばあいに、このセマフォからパーミットを取得しゅとくします。

    • コンストラクタの詳細しょうさい

      • Semaphore

        public Semaphore​(int permits)
        指定していされた数かずのパーミットと不公平ふこうへいな公平こうへい性せい設定せっていを使用しようして、Semaphoreを作成さくせいします。
        パラメータ:
        permits - 利用りよう可能かのうなパーミットの初期しょきの数かず。 この値ねは負まけにすることも可能かのうで、その場合ばあいは取得しゅとくメソッドが許可きょかを受うけ取とる前まえに解放かいほうが発生はっせいする必要ひつようがある。

      • Semaphore

        public Semaphore​(int permits,
                 boolean fair)
        指定していされた数かずのパーミットと指定していされた公平こうへい性せい設定せっていを使用しようして、Semaphoreを作成さくせいします。
        パラメータ:
        permits - 利用りよう可能かのうなパーミットの初期しょきの数かず。 この値ねは負まけにすることも可能かのうで、その場合ばあいは取得しゅとくメソッドが許可きょかを受うけ取とる前まえに解放かいほうが発生はっせいする必要ひつようがある。
        fair - このセマフォが競合きょうごう時じにパーミットの許可きょかを先入さきいれ先出さきだしで保証ほしょうする場合ばあいはtrue。それ以外いがいの場合ばあいはfalse

    • メソッドの詳細しょうさい

      • acquire

        public void acquire​()
             throws InterruptedException
        このセマフォからパーミットを取得しゅとくします。パーミットが利用りよう可能かのうになるか、またはスレッドが割わり込こみされるまでブロックします。

        パーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくしてすぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは1つずつ減へります。

        パーミットが利用りよう可能かのうでない場合ばあい、現在げんざいのスレッドはスレッドのスケジューリングに関かんして無効むこうになり、次つぎの2つのいずれかが起おきるまで待機たいきします。

        • ほかのスレッドがこのセマフォに対たいしてrelease()メソッドを呼よび出だし、現在げんざいのスレッドが次つぎにパーミットを割わり当あてられるスレッドになる。
        • ほかのスレッドが現在げんざいのスレッドに割わり込こみを行おこなう。

        現在げんざいのスレッドで、

        • このメソッドへのエントリ上じょうで設定せっていされた割込わりこみステータスが保持ほじされるか、
        • パーミットの待機たいき中ちゅうに割わり込こみが発生はっせいした場合ばあい、
        InterruptedExceptionがスローされ、現在げんざいのスレッドの割込わりこみステータスがクリアされます。
        例外れいがい:
        InterruptedException - 現在げんざいのスレッドで割込わりこみが発生はっせいした場合ばあい

      • acquireUninterruptibly

        public void acquireUninterruptibly​()
        このセマフォからパーミットを取得しゅとくします。パーミットが利用りよう可能かのうになるまでブロックします。

        パーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくしてすぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは1つずつ減へります。

        パーミットが使用しようできない場合ばあい、現在げんざいのスレッドはスレッドのスケジューリングの目的もくてきに対たいして無効むこうになり、ほかのいずれかのスレッドがこのセマフォのrelease()メソッドを呼よび出だして、現在げんざいのスレッドが次つぎにパーミットを割わり当あてられるスレッドになるまで、現在げんざいのスレッドは待機たいきします。

        パーミットの待機たいき中ちゅうに現在げんざいのスレッドが割わり込こみされると、待機たいきは続行ぞっこうしますが、スレッドにパーミットが割わり当あてられるタイミングは、割込わりこみが発生はっせいしなかった場合ばあいにパーミットを受うけ取とるはずのタイミングとは異ことなることがあります。 スレッドがこのメソッドから復帰ふっきすると、その割込わりこみ状態じょうたいが設定せっていされます。

      • tryAcquire

        public boolean tryAcquire​()
        パーミットが呼出よびだし時じに利用りよう可能かのうな場合ばあいに限かぎり、このセマフォからパーミットを取得しゅとくします。

        パーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくして値ねtrueですぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは1つずつ減へります。

        パーミットが利用りよう可能かのうでない場合ばあい、このメソッドは値ねfalseですぐに復帰ふっきします。

        このセマフォが公平こうへい順序付じゅんじょづけポリシーを使用しようするように設定せっていされている場合ばあいでも、パーミットが利用りよう可能かのうであれば、ほかのスレッドが現在げんざい待機たいきしているかどうかに関係かんけいなく、tryAcquire()の呼出よびだしですぐにパーミットを取得しゅとくします。 この「バージ」(barging)動作どうさにより公平こうへい性せいが失うしなわれるとは言いえ、これは特定とくていの状況じょうきょう下かで有用ゆうようです。 公平こうへい性せい設定せっていを尊重そんちょうする場合ばあいは、ほぼ等価とうかなtryAcquire(0, TimeUnit.SECONDS) を使用しようします(これも割込わりこみを検出けんしゅつする)。

        戻もどり値ち:
        パーミットが取得しゅとくされた場合ばあいはtrue。それ以外いがいの場合ばあいはfalse

      • tryAcquire

        public boolean tryAcquire​(long timeout,
                          TimeUnit unit)
                   throws InterruptedException
        指定していされた待機たいき時間じかん内ないでパーミットが利用りよう可能かのうになり、現在げんざいのスレッドで割わり込こみが発生はっせいしていない場合ばあいに、このセマフォからパーミットを取得しゅとくします。

        パーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくして値ねtrueですぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは1つずつ減へります。

        パーミットが利用りよう可能かのうでない場合ばあい、現在げんざいのスレッドはスレッドのスケジューリングに関かんして無効むこうになり、次つぎの3つのいずれかが起おきるまで待機たいきします。

        • ほかのスレッドがこのセマフォに対たいしてrelease()メソッドを呼よび出だし、現在げんざいのスレッドが次つぎにパーミットを割わり当あてられるスレッドになる。
        • ほかのスレッドが現在げんざいのスレッドに割わり込こみを行おこなう。または
        • 指定していされた待機たいき時間じかんが経過けいかする。

        パーミットが取得しゅとくされた場合ばあいは、値ねtrueが返かえされます。

        現在げんざいのスレッドで、

        • このメソッドへのエントリ上じょうで設定せっていされた割込わりこみステータスが保持ほじされるか、
        • パーミットの取得しゅとくの待機たいき中ちゅうに割わり込こみが発生はっせいした場合ばあい、
        InterruptedExceptionがスローされ、現在げんざいのスレッドの割込わりこみステータスがクリアされます。

        指定していされた待機たいき時間じかんが経過けいかすると、値ねfalseが返かえされます。 時間じかんがゼロまたはそれより小ちいさい場合ばあい、メソッドは待機たいきしません。

        パラメータ:
        timeout - パーミットの最長さいちょう待機たいき時間じかん
        unit - timeout引数ひきすうの時間じかん単位たんい
        戻もどり値ち:
        パーミットが取得しゅとくされた場合ばあいはtrue。パーミットが取得しゅとくされる前まえに待機たいき時間じかんが経過けいかした場合ばあいはfalse
        例外れいがい:
        InterruptedException - 現在げんざいのスレッドで割込わりこみが発生はっせいした場合ばあい

      • release

        public void release​()
        パーミットを解放かいほうし、セマフォに戻もどします。

        パーミットを解放かいほうすると、利用りよう可能かのうなパーミットの数かずが1つずつ増ふえます。 いくつかのスレッドがパーミットを取得しゅとくしようと試こころみている場合ばあいは、その中なかの1つのスレッドが選択せんたくされ、解放かいほうされたばかりのパーミットが与あたえられます。 そのスレッドは、スレッドのスケジューリングに関かんして(ふたたび)有効ゆうこうになります。

        パーミットを解放かいほうするスレッドは、acquire()の呼出よびだしでそのパーミットを取得しゅとくしている必要ひつようはありません。 セマフォの適切てきせつな使用しよう法ほうは、アプリケーションでのプログラミング規約きやくで確立かくりつされます。

      • acquire

        public void acquire​(int permits)
             throws InterruptedException
        このセマフォから指定していされた数かずのパーミットを取得しゅとくします。すべてのパーミットが利用りよう可能かのうになるか、またはスレッドが割わり込こみされるまでブロックします。

        指定していされた数かずのパーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくしてすぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは指定していされた数かずずつ減へります。 このメソッドは、ループをfor (int i = 0; i < permits; ++i) acquire();と同おなじ効果こうかがありますが、パーツを原子げんし的てきにまとめて取得しゅとくする点てんが異ことなります:

        十分じゅうぶんな数かずのパーミットが利用りよう可能かのうでない場合ばあい、現在げんざいのスレッドはスレッドのスケジューリングに関かんして無効むこうになり、次つぎの2つのいずれかが起おきるまで待機たいきします。

        • 他たのスレッドはこのセマフォのreleaseメソッドの1つを呼よび出だし、現在げんざいのスレッドは次つぎに許可きょかを割わり当あてられ、使用しよう可能かのうな許可きょかの数かずがこのリクエストを満みたします。または
        • ほかのスレッドが現在げんざいのスレッドに割わり込こみを行おこなう。

        現在げんざいのスレッドで、

        • このメソッドへのエントリ上じょうで設定せっていされた割込わりこみステータスが保持ほじされるか、
        • パーミットの待機たいき中ちゅうに割わり込こみが発生はっせいした場合ばあい、
        InterruptedExceptionがスローされ、現在げんざいのスレッドの割込わりこみステータスがクリアされます。 このスレッドに割わり当あてられるはずだったすべてのパーミットは、release()の呼出よびだしでパーミットが利用りよう可能かのうになったかのように、パーミットの取得しゅとくを試こころみる別べつのスレッドに割わり当あてられます。
        パラメータ:
        permits - 取得しゅとくするパーミットの数かず
        例外れいがい:
        InterruptedException - 現在げんざいのスレッドで割込わりこみが発生はっせいした場合ばあい
        IllegalArgumentException - permitsが負まけである場合ばあい

      • acquireUninterruptibly

        public void acquireUninterruptibly​(int permits)
        このセマフォから指定していされた数かずのパーミットを取得しゅとくします。すべてのパーミットが利用りよう可能かのうになるまでブロックします。

        指定していされた数かずのパーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくしてすぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは指定していされた数かずずつ減へります。 このメソッドは、ループをfor (int i = 0; i < permits; ++i) acquireUninterruptibly();と同おなじ効果こうかがありますが、パーツを原子げんし的てきにまとめて取得しゅとくする点てんが異ことなります:

        不十分ふじゅうぶんな許可きょかが利用りよう可能かのうな場合ばあい、現在げんざいのスレッドはスレッド・スケジューリングの目的もくてきで無効むこうになり、他たのスレッドがこのセマフォのreleaseメソッドの1つを呼よび出だし、現在げんざいのスレッドが次つぎに許可きょかを割わり当あてられ、利用りよう可能かのうな許可きょかの数かずがこのリクエストを満みたすまで。

        現在げんざいのスレッドがパーミットの待機たいき中ちゅうに割わり込こまれた場合ばあい、待機たいきを続行ぞっこうします。キュー内ないでの現在げんざいのスレッドの位置いちには影響えいきょうありません。 スレッドがこのメソッドから復帰ふっきすると、その割込わりこみ状態じょうたいが設定せっていされます。

        パラメータ:
        permits - 取得しゅとくするパーミットの数かず
        例外れいがい:
        IllegalArgumentException - permitsが負まけである場合ばあい

      • tryAcquire

        public boolean tryAcquire​(int permits)
        指定していされた数かずのパーミットが呼出よびだし時じに利用りよう可能かのうな場合ばあいに限かぎり、それらすべてのパーミットを取得しゅとくします。

        指定していされた数かずのパーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくして値ねtrueですぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは指定していされた数かずずつ減へります。

        十分じゅうぶんな数かずのパーミットが利用りよう可能かのうでない場合ばあい、このメソッドは値ねfalseですぐに復帰ふっきし、利用りよう可能かのうなパーミットの数かずは変化へんかしません。

        このセマフォが公平こうへい順序付じゅんじょづけポリシーを使用しようするように設定せっていされている場合ばあいでも、パーミットが利用りよう可能かのうであれば、ほかのスレッドが現在げんざい待機たいきしているかどうかに関係かんけいなく、tryAcquireの呼出よびだしですぐにパーミットを取得しゅとくします。 この「バージ」(barging)動作どうさにより公平こうへい性せいが失うしなわれるとは言いえ、これは特定とくていの状況じょうきょう下かで有用ゆうようです。 公平こうへい性せい設定せっていを尊重そんちょうする場合ばあいは、ほぼ等価とうかなtryAcquire(permits, 0, TimeUnit.SECONDS) を使用しようします(これも割込わりこみを検出けんしゅつする)。

        パラメータ:
        permits - 取得しゅとくするパーミットの数かず
        戻もどり値ち:
        パーミットが取得しゅとくされた場合ばあいはtrue。それ以外いがいの場合ばあいはfalse
        例外れいがい:
        IllegalArgumentException - permitsが負まけである場合ばあい

      • tryAcquire

        public boolean tryAcquire​(int permits,
                          long timeout,
                          TimeUnit unit)
                   throws InterruptedException
        指定していされた待機たいき時間じかん内ないで指定していされた数かずのパーミットが利用りよう可能かのうであり、現在げんざいのスレッドで割わり込こみが発生はっせいしていない場合ばあいに、このセマフォから指定していされた数かずのパーミットを取得しゅとくします。

        指定していされた数かずのパーミットが利用りよう可能かのうな場合ばあいはパーミットを取得しゅとくして値ねtrueですぐに復帰ふっきするため、利用りよう可能かのうなパーミットの数かずは指定していされた数かずずつ減へります。

        十分じゅうぶんな数かずのパーミットが利用りよう可能かのうでない場合ばあい、現在げんざいのスレッドはスレッドのスケジューリングに関かんして無効むこうになり、次つぎの3つのいずれかが起おきるまで待機たいきします。

        • 他たのスレッドはこのセマフォのreleaseメソッドの1つを呼よび出だし、現在げんざいのスレッドは次つぎに許可きょかを割わり当あてられ、使用しよう可能かのうな許可きょかの数かずがこのリクエストを満みたします。または
        • ほかのスレッドが現在げんざいのスレッドに割わり込こみを行おこなう。または
        • 指定していされた待機たいき時間じかんが経過けいかする。

        パーミットが取得しゅとくされた場合ばあいは、値ねtrueが返かえされます。

        現在げんざいのスレッドで、

        • このメソッドへのエントリ上じょうで設定せっていされた割込わりこみステータスが保持ほじされるか、
        • パーミットの取得しゅとくの待機たいき中ちゅうに割わり込こみが発生はっせいした場合ばあい、
        InterruptedExceptionがスローされ、現在げんざいのスレッドの割込わりこみステータスがクリアされます。 このスレッドに割わり当あてられるはずだったすべてのパーミットは、release()の呼出よびだしでパーミットが利用りよう可能かのうになったかのように、パーミットの取得しゅとくを試こころみる別べつのスレッドに割わり当あてられます。

        指定していされた待機たいき時間じかんが経過けいかすると、値ねfalseが返かえされます。 時間じかんがゼロまたはそれより小ちいさい場合ばあい、メソッドは待機たいきしません。 このスレッドに割わり当あてられるはずだったすべてのパーミットは、release()の呼出よびだしでパーミットが利用りよう可能かのうになったかのように、パーミットの取得しゅとくを試こころみる別べつのスレッドに割わり当あてられます。

        パラメータ:
        permits - 取得しゅとくするパーミットの数かず
        timeout - パーミットの最長さいちょう待機たいき時間じかん
        unit - timeout引数ひきすうの時間じかん単位たんい
        戻もどり値ち:
        すべてのパーミットが取得しゅとくされた場合ばあいはtrue。すべてのパーミットが取得しゅとくされる前まえに待機たいき時間じかんが経過けいかした場合ばあいはfalse
        例外れいがい:
        InterruptedException - 現在げんざいのスレッドで割込わりこみが発生はっせいした場合ばあい
        IllegalArgumentException - permitsが負まけである場合ばあい

      • release

        public void release​(int permits)
        指定していされた数かずのパーミットを解放かいほうし、セマフォに戻もどします。

        指定していされた数かずのパーミットを解放かいほうすると、利用りよう可能かのうなパーミットの数かずがその分ぶん増ふえます。 許可きょかを取得しゅとくしようとしているスレッドがあれば、1つのスレッドが選択せんたくされ、今こんリリースされた許可きょかが与あたえられます。 利用りよう可能かのうなパーミットの数かずがそのスレッドの要求ようきゅうを満みたす場合ばあい、そのスレッドはスレッドのスケジューリングに関かんして(ふたたび)有効ゆうこうになります。そうでない場合ばあい、十分じゅうぶんなパーミットが利用りよう可能かのうになるまでスレッドは待機たいきします。 このスレッドの要求ようきゅうを満みたしたあとも引ひき続つづきパーミットが利用りよう可能かのうな場合ばあい、それらのパーミットはパーミットを取得しゅとくしようとしている別べつのスレッドに割わり当あてられます。

        パーミットを解放かいほうするスレッドは、acquireの呼出よびだしでそのパーミットを取得しゅとくしている必要ひつようはありません。 セマフォの適切てきせつな使用しよう法ほうは、アプリケーションでのプログラミング規約きやくで確立かくりつされます。

        パラメータ:
        permits - 解放かいほうするパーミットの数かず
        例外れいがい:
        IllegalArgumentException - permitsが負まけである場合ばあい

      • availablePermits

        public int availablePermits​()
        このセマフォで現在げんざい利用りよう可能かのうなパーミットの数かずを返かえします。

        通常つうじょう、このメソッドはデバッグとテストの場合ばあいに使用しようします。

        戻もどり値ち:
        このセマフォで利用りよう可能かのうなパーミットの数かず

      • drainPermits

        public int drainPermits​()
        すぐに利用りよう可能かのうなすべての許可きょかを取得しゅとくして返かえします。または、否定ひてい的てきな許可きょかが利用りよう可能かのうな場合ばあいは、それらを解放かいほうします。 返却へんきゃく時じには、ゼロ許可きょかが利用りよう可能かのうです。
        戻もどり値ち:
        取得しゅとくされた許可きょかの数かず、または、もしあれば、リリースされた数かず

      • reducePermits

        protected void reducePermits​(int reduction)
        指定していされたreductionの数かずだけ利用りよう可能かのうなパーミットの数かずを減へらします。 このメソッドは、利用りよう不可能ふかのうになるリソースを追跡ついせきするためにセマフォを使用しようするサブクラスで有用ゆうようです。 パーミットが利用りよう可能かのうになるまでブロックして待機たいきしない点てんで、このメソッドはacquireと異ことなります。
        パラメータ:
        reduction - 削除さくじょするパーミットの数かず
        例外れいがい:
        IllegalArgumentException - reductionが負まけである場合ばあい

      • isFair

        public boolean isFair​()
        このセマフォで公平こうへい性せいがtrueに設定せっていされている場合ばあいはtrueを返かえします。
        戻もどり値ち:
        このセマフォで公平こうへい性せいがtrueに設定せっていされている場合ばあいはtrue

      • hasQueuedThreads

        public final boolean hasQueuedThreads​()
        パーミットの取得しゅとくを待機たいき中ちゅうのスレッドが存在そんざいするかどうかを照会しょうかいします。 取消とりけしはいつでも発生はっせいする可能かのう性せいがあるため、trueが返かえされても、ほかのいずれかのスレッドが取得しゅとくするとは保証ほしょうされていないことに注意ちゅういしてください。 このメソッドは、主おもにシステム状態じょうたいの監視かんしに使用しようする目的もくてきで設計せっけいされています。
        戻もどり値ち:
        ロックの取得しゅとくを待機たいき中ちゅうのほかのスレッドが存在そんざいする可能かのう性せいがある場合ばあいはtrue

      • getQueueLength

        public final int getQueueLength​()
        パーミットの取得しゅとくを待機たいきしているスレッドの推定すいてい数すうを返かえします。 このメソッドが内部ないぶのデータ構造こうぞうをトラバースしている間あいだにも、スレッド数すうが動的どうてきに変化へんかする場合ばあいがあるため、この値ねは推定すいていに過すぎません。 このメソッドは、同期どうきの制御せいぎょ用ようとしてではなく、システム状態じょうたいの監視かんし用ようとして設計せっけいされています。
        戻もどり値ち:
        このロックを待機たいきしているスレッドの推定すいてい数すう

      • getQueuedThreads

        protected Collection<Thread> getQueuedThreads​()
        パーミットの取得しゅとくを待機たいきしているスレッドを含ふくむコレクションを返かえします。 実際じっさいのスレッド・セットは、結果けっかの構築こうちく中ちゅうにも動的どうてきに変化へんかする可能かのう性せいがあるため、返かえされるコレクションは最善さいぜんの努力どりょくを払はらった上うえでの推定すいていに過すぎません。 返かえされるコレクションの要素ようそには、特定とくていの順序じゅんじょは存在そんざいしません。 このメソッドは、より包括ほうかつ的てきな監視かんし機能きのうを提供ていきょうするサブクラスの構築こうちくを容易よういにする目的もくてきで設計せっけいされています。
        戻もどり値ち:
        スレッドのコレクション

      • toString

        public String toString​()
        セマフォおよびその状態じょうたいを識別しきべつする文字もじ列れつを返かえします。 状態じょうたいは括弧かっこで囲かこまれ、文字もじ列れつ"Permits ="に続つづいてパーミットの数かずが含ふくまれます。
        オーバーライド:
        toString、クラス: Object
        戻もどり値ち:
        このセマフォおよびその状態じょうたいを識別しきべつする文字もじ列れつ