org.springframework.data.redis.core

Class ConvertingCursor<S,T>

java.lang.Object

org.springframework.data.redis.core.ConvertingCursor<S,T>

Type Parameters:

S -

T -

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<T>, Cursor<T>, CloseableIterator<T>

public class ConvertingCursor<S,T>
extends Object
implements Cursor<T>

ConvertingCursor wraps a given cursor and applies given Converter to items prior to returning them. This allows to easily perform required conversion whereas the underlying implementation may still work with its native types.

Since:

1.4

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
ConvertingCursor(Cursor<S> cursor, Converter<S,T> converter)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getCursorId() Get the reference cursor.
long	getPosition()
boolean	hasNext()
boolean	isClosed()
T	next()
Cursor<T>	open() Opens cursor and returns itself.
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.util.CloseableIterator

spliterator, stream

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ConvertingCursor

public ConvertingCursor(Cursor<S> cursor,
                        Converter<S,T> converter)

Parameters:

cursor - Cursor must not be null.

converter - Converter must not be null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

@Nullable
public T next()

Specified by:

next in interface Iterator<T>

remove

public void remove()

Specified by:

remove in interface Iterator<T>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableIterator<T>

getCursorId

public long getCursorId()

Description copied from interface: Cursor

Get the reference cursor.
NOTE: the id might change while iterating items.

Specified by:

getCursorId in interface Cursor<T>

Returns:

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Cursor<T>

Returns:

true if cursor closed.

open

public Cursor<T> open()

Description copied from interface: Cursor

Opens cursor and returns itself. This method is intended to be called by components constructing a Cursor and should not be called externally.

Specified by:

open in interface Cursor<T>

Returns:

the opened cursor.

getPosition

public long getPosition()

Specified by:

getPosition in interface Cursor<T>

Returns:

the current position of the cursor.