クラス ScanCursor<T>
java.lang.ObjectSE
org.springframework.data.redis.core.ScanCursor<T>
- 型パラメーター:
T
-
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、IteratorSE<T>
、Cursor<T>
、CloseableIterator<T>
- 既知の直属サブクラス
KeyBoundCursor
Redis クライアントに依存しない
注 :
Cursor
実装は、開始点 zero
に到達するまで Redis サーバーから追加の結果を継続的にロードします。注 :
ScanCursor
は、使用前に初期化する必要があることに注意してください ( open()
。スキャン中にエラーが発生すると、カーソルが close
になり、接続などの関連リソースが解放されます。- 導入:
- 1.4
- 作成者:
- Christoph Strobl, Thomas Darimont, Duobiao Ou, Marl Paluch
ネストされたクラスのサマリー
インターフェース org.springframework.data.redis.core.Cursor から継承されたネストクラス / インターフェース
Cursor.CursorId
コンストラクターのサマリー
コンストラクターコンストラクター説明初期カーソルとScanOptions.NONE
を使用して新しいScanCursor
を作成しますScanCursor
(long cursorId) 使用すべきではありません。ScanCursor
(long cursorId, ScanOptions options) 使用すべきではありません。3.3.0 以降 - 代わりにScanCursor(CursorId, ScanOptions)
を使用してください。ScanCursor
(Cursor.CursorId cursorId) ScanOptions.NONE
で新しいScanCursor
を作成しますScanCursor
(Cursor.CursorId cursorId, ScanOptions options) 新しいScanCursor
を作成しますScanCursor
(ScanOptions options) 初期カーソルを使用して新しいScanCursor
を作成します。メソッドのサマリー
修飾子と型メソッド説明final void
close()
protected void
doClose()
close()
を呼び出すときにリソースをクリーンアップするためのカスタマイズフック。protected void
doOpen
(long cursorId) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。3.3.0 以降、代わりにdoOpen(CursorId)
を使用してください。protected void
doOpen
(Cursor.CursorId cursorId) open()
を呼び出すときのカスタマイズフック。protected ScanIteration<T>
doScan
(long cursorId, ScanOptions options) 使用すべきではありません。3.3.0 (cursorId) はLong.MAX_VALUE
SE を超える可能性があるためです。protected ScanIteration<T>
doScan
(Cursor.CursorId cursorId, ScanOptions options) ネイティブクライアントの実装を使用して、実際のスキャンコマンドを実行します。long
参照カーソルを取得します。getId()
参照カーソルを返します。long
boolean
hasNext()
boolean
isClosed()
protected boolean
isFinished
(long cursorId) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。protected boolean
isFinished
(Cursor.CursorId cursorId) cursorId
が終了しているか確認してください。protected final boolean
isOpen()
protected final boolean
isReady()
protected T
moveNext
(IteratorSE<T> source) 基になるIterable
SE から次のアイテムをフェッチします。next()
final ScanCursor<T>
open()
使用する前にCursor
を初期化します。void
remove()
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.data.util.CloseableIterator から継承されたメソッド
spliterator, stream
インターフェース java.util.IteratorSE から継承されたメソッド
forEachRemainingSE
コンストラクターの詳細
ScanCursor
public ScanCursor()初期カーソルとScanOptions.NONE
を使用して新しいScanCursor
を作成しますScanCursor
初期カーソルを使用して新しいScanCursor
を作成します。- パラメーター:
options
- 適用するスキャンオプション。
ScanCursor
使用すべきではありません。3.3.0 以降 - 代わりにScanCursor(CursorId)
を使用してください。ScanOptions.NONE
で新しいScanCursor
を作成します- パラメーター:
cursorId
- カーソル ID。
ScanCursor
ScanOptions.NONE
で新しいScanCursor
を作成します- パラメーター:
cursorId
- カーソル ID。- 導入:
- 3.3.0
ScanCursor
使用すべきではありません。3.3.0 以降 - 代わりにScanCursor(CursorId, ScanOptions)
を使用してください。新しいScanCursor
を作成します- パラメーター:
cursorId
- カーソル ID。options
-null
の場合、デフォルトでScanOptions.NONE
になります。
ScanCursor
新しいScanCursor
を作成します- パラメーター:
cursorId
- カーソル ID。options
-null
の場合、デフォルトでScanOptions.NONE
になります。- 導入:
- 3.3.0
メソッドの詳細
doScan
使用すべきではありません。3.3.0 (cursorId) はLong.MAX_VALUE
SE を超える可能性があるためです。ネイティブクライアントの実装を使用して、実際のスキャンコマンドを実行します。指定されたオプションは決してnull
ではありません。- パラメーター:
cursorId
-options
-- 戻り値:
doScan
ネイティブクライアントの実装を使用して、実際のスキャンコマンドを実行します。指定されたオプションは決してnull
ではありません。- パラメーター:
cursorId
-options
-- 戻り値:
- 導入:
- 3.3.0
open
使用する前にCursor
を初期化します。doOpen
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。3.3.0 以降、代わりにdoOpen(CursorId)
を使用してください。open()
を呼び出すときのカスタマイズフック。- パラメーター:
cursorId
-
doOpen
open()
を呼び出すときのカスタマイズフック。- パラメーター:
cursorId
-
isFinished
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。cursorId
が終了しているか確認してください。- パラメーター:
cursorId
- カーソル ID- 戻り値:
- カーソルが終了したと見なされる場合は true、それ以外の場合は false。
- 導入:
- 2.1
isFinished
cursorId
が終了しているか確認してください。- パラメーター:
cursorId
- カーソル ID- 戻り値:
- カーソルが終了したと見なされる場合は true、それ以外の場合は false。
- 導入:
- 3.3.0
getId
インターフェースからコピーされた説明:Cursor
参照カーソルを返します。getCursorId
public long getCursorId()インターフェースからコピーされた説明:Cursor
参照カーソルを取得します。
注 : アイテムの反復中に ID が変更される場合があります。- 次で指定:
- インターフェース
Cursor<T>
のgetCursorId
- 戻り値:
hasNext
public boolean hasNext()- 次で指定:
- インターフェース
IteratorSE<T>
のhasNext
next
- 次で指定:
- インターフェース
IteratorSE<T>
のnext
moveNext
基になるIterable
SE から次のアイテムをフェッチします。- パラメーター:
source
-- 戻り値:
remove
public void remove()- 次で指定:
- インターフェース
IteratorSE<T>
のremove
close
public final void close()- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 次で指定:
- インターフェース
CloseableIterator<T>
のclose
doClose
protected void doClose()close()
を呼び出すときにリソースをクリーンアップするためのカスタマイズフック。isClosed
public boolean isClosed()isReady
protected final boolean isReady()isOpen
protected final boolean isOpen()getPosition
public long getPosition()- 次で指定:
- インターフェース
Cursor<T>
のgetPosition
- 戻り値:
- カーソルの現在の位置。
ScanCursor(CursorId)
を使用してください。