MessageGroupQueue (Spring Integration API)

java.lang.ObjectSE
- java.util.AbstractCollectionSE<E>
- - java.util.AbstractQueueSE<Message<?>>
  - - org.springframework.integration.store.MessageGroupQueue

実装されているすべてのインターフェース:
IterableSE<Message<?>>, CollectionSE<Message<?>>, BlockingQueueSE<Message<?>>, QueueSE<Message<?>>
```
public class MessageGroupQueue
extends AbstractQueueSE<Message<?>>
implements BlockingQueueSE<Message<?>>
```
MessageGroupStore による BlockingQueueSE。トランザクションのロールバックに直面した場合の確実な配信（ストアがトランザクションであると想定）、およびプロセスが停止した場合にメッセージが失われないようにする（ストアが永続的であると想定）ために使用できます。プロセスの再起動全体でキューを使用するには、同じグループ ID を指定する必要があるため、キューの単一の論理インスタンスで一意であるが識別可能である必要があります。
導入:
2.0
作成者:
Dave Syer, Oleg Zhurakousky, Gunnar Hillert, Gary Russell

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MessageGroupQueue(BasicMessageGroupStore messageGroupStore, ObjectSE groupId)`
`MessageGroupQueue(BasicMessageGroupStore messageGroupStore, ObjectSE groupId, int capacity)`
`MessageGroupQueue(BasicMessageGroupStore messageGroupStore, ObjectSE groupId, int capacity, LockSE storeLock)`
`MessageGroupQueue(BasicMessageGroupStore messageGroupStore, ObjectSE groupId, LockSE storeLock)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected boolean`	`doOffer(Message<?> message)` 'storeLock' は呼び出し側によって保持されているものと想定されます。そうでない場合は、IllegalMonitorStateException がスローされる可能性があります。
`protected Message<?>`	`doPoll()` 'storeLock' は呼び出し側によって保持されているものと想定されます。そうでない場合は、IllegalMonitorStateException がスローされる可能性があります。
`int`	`drainTo(CollectionSE<? super Message<?>> c)`
`int`	`drainTo(CollectionSE<? super Message<?>> collection, int maxElements)`
`protected BasicMessageGroupStore`	`getMessageGroupStore()` ストアを取得します。
`protected CollectionSE<Message<?>>`	`getMessages()`
`protected ConditionSE`	`getMessageStoreNotEmpty()` 空ではない状態を取得します。
`protected ConditionSE`	`getMessageStoreNotFull()` 完全ではない状態になります。
`protected LockSE`	`getStoreLock()` ストアロックを取得します。
`IteratorSE<Message<?>>`	`iterator()`
`boolean`	`offer(Message<?> message)`
`boolean`	`offer(Message<?> message, long timeout, TimeUnitSE unit)`
`Message<?>`	`peek()`
`Message<?>`	`poll()`
`Message<?>`	`poll(long timeout, TimeUnitSE unit)`
`void`	`put(Message<?> message)`
`int`	`remainingCapacity()`
`void`	`setPriority(boolean priority)` true の場合、メッセージストアが優先度をサポートしていることを確認します。
`int`	`size()`
`Message<?>`	`take()`

クラス java.util.AbstractQueueSE から継承されたメソッド
addSE, addAllSE, clearSE, elementSE, removeSE

クラス java.util.AbstractCollectionSE から継承されたメソッド
containsSE, containsAllSE, isEmptySE, removeSE, removeAllSE, retainAllSE, toArraySE, toArraySE, toStringSE

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース java.util.concurrent.BlockingQueueSE から継承されたメソッド
addSE, containsSE, removeSE

インターフェース java.util.QueueSE から継承されたメソッド
elementSE, removeSE

インターフェース java.util.CollectionSE から継承されたメソッド
addAllSE, clearSE, containsAllSE, equalsSE, hashCodeSE, isEmptySE, parallelStreamSE, removeAllSE, removeIfSE, retainAllSE, spliteratorSE, streamSE, toArraySE, toArraySE

インターフェース java.lang.IterableSE から継承されたメソッド
forEachSE

- コンストラクターの詳細
  - MessageGroupQueue
```
public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         ObjectSE groupId)
```
  - MessageGroupQueue
```
public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         ObjectSE groupId,
                         int capacity)
```
  - MessageGroupQueue
```
public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         ObjectSE groupId,
                         LockSE storeLock)
```
  - MessageGroupQueue
```
public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         ObjectSE groupId,
                         int capacity,
                         LockSE storeLock)
```
- メソッドの詳細
  - setPriority
```
public void setPriority(boolean priority)
```
    true の場合、メッセージストアが優先度をサポートしていることを確認します。false の場合メッセージストアが優先度を使用して受信時にメッセージの順序を決定する場合に警告します。
    パラメーター:
    priority - 優先度が使用されると予想される場合は true。
  - iterator
```
public IteratorSE<Message<?>> iterator()
```
    次で指定:
    インターフェース IterableSE<Message<?>> の iteratorSE
    次で指定:
    インターフェース CollectionSE<Message<?>> の iteratorSE
    次で指定:
    クラス AbstractCollectionSE<Message<?>> の iteratorSE
  - getMessageGroupStore
```
protected BasicMessageGroupStore getMessageGroupStore()
```
    ストアを取得します。
    戻り値:
    ストア。
    導入:
    5.0.11
  - getStoreLock
```
protected LockSE getStoreLock()
```
    ストアロックを取得します。
    戻り値:
    ロック。
    導入:
    5.0.11
  - getMessageStoreNotFull
```
protected ConditionSE getMessageStoreNotFull()
```
    完全ではない状態になります。
    戻り値:
    状態。
    導入:
    5.0.11
  - getMessageStoreNotEmpty
```
protected ConditionSE getMessageStoreNotEmpty()
```
    空ではない状態を取得します。
    戻り値:
    状態。
    導入:
    5.0.11
  - size
```
public int size()
```
    次で指定:
    インターフェース CollectionSE<Message<?>> の sizeSE
    次で指定:
    クラス AbstractCollectionSE<Message<?>> の sizeSE
  - peek
```
public Message<?> peek()
```
    次で指定:
    インターフェース QueueSE<Message<?>> の peekSE
  - poll
```
public Message<?> poll(long timeout,
                       TimeUnitSE unit)
                throws InterruptedExceptionSE
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の pollSE
    例外:
    InterruptedExceptionSE
  - poll
```
public Message<?> poll()
```
    次で指定:
    インターフェース QueueSE<Message<?>> の pollSE
  - drainTo
```
public int drainTo(CollectionSE<? super Message<?>> c)
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の drainToSE
  - drainTo
```
public int drainTo(CollectionSE<? super Message<?>> collection,
                   int maxElements)
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の drainToSE
  - offer
```
public boolean offer(Message<?> message)
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の offerSE
    次で指定:
    インターフェース QueueSE<Message<?>> の offerSE
  - offer
```
public boolean offer(Message<?> message,
                     long timeout,
                     TimeUnitSE unit)
              throws InterruptedExceptionSE
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の offerSE
    例外:
    InterruptedExceptionSE
  - put
```
public void put(Message<?> message)
         throws InterruptedExceptionSE
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の putSE
    例外:
    InterruptedExceptionSE
  - remainingCapacity
```
public int remainingCapacity()
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の remainingCapacitySE
  - take
```
public Message<?> take()
                throws InterruptedExceptionSE
```
    次で指定:
    インターフェース BlockingQueueSE<Message<?>> の takeSE
    例外:
    InterruptedExceptionSE
  - getMessages
```
protected CollectionSE<Message<?>> getMessages()
```
  - doPoll
```
protected Message<?> doPoll()
```
    'storeLock' は呼び出し側によって保持されているものと想定されます。そうでない場合は、IllegalMonitorStateException がスローされる可能性があります。
    戻り値:
    メッセージ // TODO @Nullable
  - doOffer
```
protected boolean doOffer(Message<?> message)
```
    'storeLock' は呼び出し側によって保持されているものと想定されます。そうでない場合は、IllegalMonitorStateException がスローされる可能性があります。
    パラメーター:
    message - 提供するメッセージ。
    戻り値:
    提供された場合は true。

クラス MessageGroupQueue

コンストラクターの概要

メソッドのサマリー

クラス java.util.AbstractQueueSE から継承されたメソッド

クラス java.util.AbstractCollectionSE から継承されたメソッド

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

インターフェース java.util.concurrent.BlockingQueueSE から継承されたメソッド

インターフェース java.util.QueueSE から継承されたメソッド

インターフェース java.util.CollectionSE から継承されたメソッド

インターフェース java.lang.IterableSE から継承されたメソッド

コンストラクターの詳細

MessageGroupQueue

MessageGroupQueue

MessageGroupQueue

MessageGroupQueue

メソッドの詳細

setPriority

iterator

getMessageGroupStore

getStoreLock

getMessageStoreNotFull

getMessageStoreNotEmpty

size

peek

poll

poll

drainTo

drainTo

offer

offer

put

remainingCapacity

take

getMessages

doPoll

doOffer