UpdateRequest.java

/*
 * Copyright 2016-present 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.primitives.impl;

import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableSet;
import org.onosproject.cluster.NodeId;

import java.util.Set;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Describes a request for update events in an EventuallyConsistentMap.
 */
final class UpdateRequest<K> {

    private final NodeId sender;
    private final Set<K> keys;

    /**
     * Creates a new update request.
     *
     * @param sender the sender's node ID
     * @param keys keys requested
     */
    public UpdateRequest(NodeId sender, Set<K> keys) {
        this.sender = checkNotNull(sender);
        this.keys = ImmutableSet.copyOf(keys);
    }

    /**
     * Returns the sender's node ID.
     *
     * @return the sender's node ID
     */
    public NodeId sender() {
        return sender;
    }

    /**
     * Returns the keys.
     *
     * @return the keys
     */
    public Set<K> keys() {
        return keys;
    }

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

    @SuppressWarnings("unused")
    private UpdateRequest() {
        this.sender = null;
        this.keys = null;
    }
}