AbstractPollableChannel (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.channel.AbstractMessageChannel
  - - org.springframework.integration.channel.AbstractPollableChannel

実装されたすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExecutorChannelInterceptorAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, PollableChannel, InterceptableChannel
既知の直属サブクラス
QueueChannel
```
public abstract class AbstractPollableChannel
extends AbstractMessageChannel
implements PollableChannel, ExecutorChannelInterceptorAware
```
すべてのポーリング可能なチャネルの基本クラス。
作成者:
Mark Fisher, Artem Bilan, Gary Russell, Artem Bilan

ネストされたクラスのサマリー
- クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたネストクラス / インターフェース
  AbstractMessageChannel.ChannelInterceptorList
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたフィールド
  interceptors, meters
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.messaging.MessageChannel から継承されたフィールド
  INDEFINITE_TIMEOUT
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要
コンストラクター
コンストラクターと説明
AbstractPollableChannel()

コンストラクター
コンストラクターと説明
`AbstractPollableChannel()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addInterceptor(ChannelInterceptor interceptor)` リストの最後にチャネルインターセプターを追加します。
`void`	`addInterceptor(int index, ChannelInterceptor interceptor)` リストの指定されたインデックスにチャネルインターセプターを追加します。
`protected abstract Message<?>`	`doReceive(long timeout)` サブクラスはこのメソッドを実装する必要があります。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`boolean`	`hasExecutorInterceptors()`
`Message<?>`	`receive()` このチャネルから最初に利用可能なメッセージを受信します。
`Message<?>`	`receive(long timeout)` このチャネルから最初に利用可能なメッセージを受信します。
`boolean`	`removeInterceptor(ChannelInterceptor interceptor)`
`ChannelInterceptor`	`removeInterceptor(int index)`
`void`	`setInterceptors(ListSE<ChannelInterceptor> interceptors)` チャネルインターセプターのリストを設定します。

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたメソッド
destroy, doSend, getComponentType, getFullChannelName, getIChannelInterceptorList, getInterceptors, getMetricsCaptor, getOverrides, isLoggingEnabled, onInit, registerMetricsCaptor, send, send, setDatatypes, setLoggingEnabled, setMessageConverter, setShouldTrack

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

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

インターフェース org.springframework.messaging.MessageChannel から継承されたメソッド
send, send

インターフェース org.springframework.messaging.support.InterceptableChannel から継承されたメソッド
getInterceptors

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - AbstractPollableChannel
```
public AbstractPollableChannel()
```
- メソッドの詳細
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    オーバーライド:
    クラス AbstractMessageChannel の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - receive
```
@Nullable
public Message<?> receive()
```
    このチャネルから最初に利用可能なメッセージを受信します。チャネルにメッセージが含まれていない場合、このメソッドはブロックします。
    次で指定:
    インターフェース PollableChannel の receive
    戻り値:
    最初に使用可能なメッセージ、または受信スレッドが中断された場合は null。
  - receive
```
@Nullable
public Message<?> receive(long timeout)
```
    このチャネルから最初に利用可能なメッセージを受信します。チャネルにメッセージが含まれていない場合、このメソッドは、割り当てられたタイムアウトが経過するまでブロックします。指定されたタイムアウトが 0 の場合、メソッドはすぐに戻ります。ゼロ未満の場合、無期限にブロックされます（receive() を参照）。
    次で指定:
    インターフェース PollableChannel の receive
    パラメーター:
    timeout - ミリ秒単位のタイムアウト
    戻り値:
    最初に使用可能なメッセージ、または割り当てられた時間内に使用可能なメッセージがない場合、または受信スレッドが中断された場合は null。
  - setInterceptors
```
public void setInterceptors(ListSE<ChannelInterceptor> interceptors)
```
    クラスからコピーされた説明: AbstractMessageChannel
    チャネルインターセプターのリストを設定します。これにより、既存のインターセプターがすべてクリアされます。
    次で指定:
    インターフェース InterceptableChannel の setInterceptors
    オーバーライド:
    クラス AbstractMessageChannel の setInterceptors
    パラメーター:
    interceptors - インターセプターのリスト。
  - addInterceptor
```
public void addInterceptor(ChannelInterceptor interceptor)
```
    クラスからコピーされた説明: AbstractMessageChannel
    リストの最後にチャネルインターセプターを追加します。
    次で指定:
    インターフェース InterceptableChannel の addInterceptor
    オーバーライド:
    クラス AbstractMessageChannel の addInterceptor
    パラメーター:
    interceptor - インターセプター。
  - addInterceptor
```
public void addInterceptor(int index,
                           ChannelInterceptor interceptor)
```
    クラスからコピーされた説明: AbstractMessageChannel
    リストの指定されたインデックスにチャネルインターセプターを追加します。
    次で指定:
    インターフェース InterceptableChannel の addInterceptor
    オーバーライド:
    クラス AbstractMessageChannel の addInterceptor
    パラメーター:
    index - インターセプターを追加するためのインデックス。
    interceptor - インターセプター。
  - removeInterceptor
```
public boolean removeInterceptor(ChannelInterceptor interceptor)
```
    次で指定:
    インターフェース InterceptableChannel の removeInterceptor
    オーバーライド:
    クラス AbstractMessageChannel の removeInterceptor
  - removeInterceptor
```
@Nullable
public ChannelInterceptor removeInterceptor(int index)
```
    次で指定:
    インターフェース InterceptableChannel の removeInterceptor
    オーバーライド:
    クラス AbstractMessageChannel の removeInterceptor
  - hasExecutorInterceptors
```
public boolean hasExecutorInterceptors()
```
    次で指定:
    インターフェース ExecutorChannelInterceptorAware の hasExecutorInterceptors
  - doReceive
```
@Nullable
protected abstract Message<?> doReceive(long timeout)
```
    サブクラスはこのメソッドを実装する必要があります。負でないタイムアウトは、チャネルが空の場合に待機する時間を示します（値が 0 の場合、成功の有無にかかわらずすぐに戻る必要があります）。負のタイムアウト値は、メッセージが使用可能になるか、ブロッキングスレッドが中断されるまでメソッドがブロックされることを示します。
    パラメーター:
    timeout - タイムアウト。
    戻り値:
    メッセージ、または null。

クラス AbstractPollableChannel

ネストされたクラスのサマリー

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたネストクラス / インターフェース

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.messaging.MessageChannel から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

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

インターフェース org.springframework.messaging.MessageChannel から継承されたメソッド

インターフェース org.springframework.messaging.support.InterceptableChannel から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

AbstractPollableChannel

メソッドの詳細

getIntegrationPatternType

receive

receive

setInterceptors

addInterceptor

addInterceptor

removeInterceptor

removeInterceptor

hasExecutorInterceptors

doReceive