core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/UnmodifiableAsyncConsistentMap.java

/*
 * Copyright 2016 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 java.util.concurrent.CompletableFuture;
import java.util.function.BiFunction;
import java.util.function.Predicate;

import org.onlab.util.Tools;
import org.onosproject.store.service.AsyncConsistentMap;
import org.onosproject.store.service.Versioned;

/**
 * An unmodifiable {@link AsyncConsistentMap}.
 * <p>
 * Any attempt to update the map through this instance will cause the
 * operation to be completed with an {@link UnsupportedOperationException}.
 *
 * @param <K> key type
 * @param <V> value type
 */
public class UnmodifiableAsyncConsistentMap<K, V> extends DelegatingAsyncConsistentMap<K, V> {

    private static final String ERROR_MSG = "map updates are not allowed";

    public UnmodifiableAsyncConsistentMap(AsyncConsistentMap<K, V> backingMap) {
        super(backingMap);
    }

    @Override
    public CompletableFuture<Versioned<V>> computeIf(K key,
            Predicate<? super V> condition,
            BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(""));
    }

    @Override
    public CompletableFuture<Versioned<V>> put(K key, V value) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Versioned<V>> putAndGet(K key, V value) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Versioned<V>> remove(K key) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Void> clear() {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Versioned<V>> putIfAbsent(K key, V value) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Boolean> remove(K key, V value) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Boolean> remove(K key, long version) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Versioned<V>> replace(K key, V value) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Boolean> replace(K key, V oldValue, V newValue) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }

    @Override
    public CompletableFuture<Boolean> replace(K key, long oldVersion, V newValue) {
        return Tools.exceptionalFuture(new UnsupportedOperationException(ERROR_MSG));
    }
}