core/api/src/main/java/org/onosproject/store/service/BatchReadRequest.java

/*
 * Copyright 2014 Open Networking Laboratory
 *
 * 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.onosproject.store.service;

import java.util.List;

import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;

/**
 * Collection of read requests to be submitted as one batch.
 */
public final class BatchReadRequest {

    private final List<ReadRequest> readRequests;

    /**
     * Creates a new BatchReadRequest object from the specified list of read requests.
     * @param readRequests read requests.
     * @return BatchReadRequest object.
     */
    public static BatchReadRequest create(List<ReadRequest> readRequests) {
        return new BatchReadRequest(readRequests);
    }

    private BatchReadRequest(List<ReadRequest> readRequests) {
        this.readRequests = ImmutableList.copyOf(readRequests);
    }

    /**
     * Returns the number of requests in this batch.
     * @return size of request batch.
     */
    public int batchSize() {
        return readRequests.size();
    }

    /**
     * Returns the requests in this batch as a list.
     * @return list of read requests
     */
    public List<ReadRequest> getAsList() {
        return readRequests;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(getClass())
                .add("readRequests", readRequests)
                .toString();
    }

    /**
     * Builder for BatchReadRequest.
     */
    public static class Builder {

        private final List<ReadRequest> readRequests = Lists.newLinkedList();

        /**
         * Append a get request.
         * @param tableName table name
         * @param key key to fetch.
         * @return this Builder
         */
        public Builder get(String tableName, String key) {
            readRequests.add(new ReadRequest(tableName, key));
            return this;
        }

        /**
         * Builds a BatchReadRequest.
         * @return BatchReadRequest
         */
        public BatchReadRequest build() {
            return new BatchReadRequest(readRequests);
        }
    }
}