com.hazelcast.client.map.impl.iterator.ClientMapPartitionIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hazelcast-java-client Show documentation

Hazelcast Java Client

The newest version!

/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.client.map.impl.iterator;

import com.hazelcast.client.impl.proxy.ClientMapProxy;

import javax.annotation.Nonnull;
import java.util.Iterator;
import java.util.Map;

/**
 * Client-side iterable that provides an iterator for iterating map
 * entries in the specified partition.
 * It returns {@link ClientMapPartitionIterator}.
 *
 * @param  the key type of map.
 * @param  the value type of map.
 * @see ClientMapPartitionIterator
 */
public class ClientMapPartitionIterable implements Iterable> {
    private final ClientMapProxy clientMapProxy;
    private final int fetchSize;
    private final int partitionId;
    private final boolean prefetchValues;

    public ClientMapPartitionIterable(ClientMapProxy clientMapProxy, int fetchSize, int partitionId,
                                      boolean prefetchValues) {
        this.clientMapProxy = clientMapProxy;
        this.partitionId = partitionId;
        this.fetchSize = fetchSize;
        this.prefetchValues = prefetchValues;
    }

    @Nonnull
    @Override
    public Iterator> iterator() {
        return clientMapProxy.iterator(fetchSize, partitionId, prefetchValues);
    }
}