org.springframework.data.redis.core.ScanIteration Maven / Gradle / Ivy
/*
* Copyright 2014-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.core;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import org.springframework.lang.Nullable;
/**
* {@link ScanIteration} holds the values contained in Redis {@literal Multibulk reply} on exectuting {@literal SCAN}
* command.
*
* @author Christoph Strobl
* @author Mark Paluch
* @since 1.4
*/
public class ScanIteration implements Iterable {
private final long cursorId;
private final Collection items;
/**
* @param cursorId
* @param items
*/
public ScanIteration(long cursorId, @Nullable Collection items) {
this.cursorId = cursorId;
this.items = (items != null ? new ArrayList<>(items) : Collections.emptyList());
}
/**
* The cursor id to be used for subsequent requests.
*
* @return
*/
public long getCursorId() {
return cursorId;
}
/**
* Get the items returned.
*
* @return
*/
public Collection getItems() {
return items;
}
/*
* (non-Javadoc)
* @see java.lang.Iterable#iterator()
*/
@Override
public Iterator iterator() {
return items.iterator();
}
}