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

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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.Collection;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;

import org.onosproject.store.service.AsyncConsistentMap;
import org.onosproject.store.service.Versioned;

/**
 * {@link org.onosproject.store.service.AsyncConsistentMap} that doesn't allow null values.
 */
public class NotNullAsyncConsistentMap<K, V> extends DelegatingAsyncConsistentMap<K, V> {
    private final AsyncConsistentMap<K, V> delegateMap;

    public NotNullAsyncConsistentMap(AsyncConsistentMap<K, V> delegateMap) {
        super(delegateMap);
        this.delegateMap = delegateMap;
    }

    @Override
    public CompletableFuture<Boolean> containsValue(V value) {
        if (value == null) {
            return CompletableFuture.completedFuture(false);
        }
        return super.containsValue(value);
    }

    @Override
    public CompletableFuture<Versioned<V>> get(K key) {
        return super.get(key).thenApply(v -> v != null && v.value() == null ? null : v);
    }

    @Override
    public CompletableFuture<Versioned<V>> getOrDefault(K key, V defaultValue) {
        return super.getOrDefault(key, defaultValue).thenApply(v -> v != null && v.value() == null ? null : v);
    }

    @Override
    public CompletableFuture<Versioned<V>> put(K key, V value) {
        if (value == null) {
            return super.remove(key);
        }
        return super.put(key, value);
    }

    @Override
    public CompletableFuture<Versioned<V>> putAndGet(K key, V value) {
        if (value == null) {
            return super.remove(key).thenApply(v -> null);
        }
        return super.putAndGet(key, value);
    }

    @Override
    public CompletableFuture<Collection<Versioned<V>>> values() {
        return super.values().thenApply(value -> value.stream()
            .filter(v -> v.value() != null)
            .collect(Collectors.toList()));
    }

    @Override
    public CompletableFuture<Set<Map.Entry<K, Versioned<V>>>> entrySet() {
        return super.entrySet().thenApply(entries -> entries.stream()
            .filter(e -> e.getValue().value() != null)
            .collect(Collectors.toSet()));
    }

    @Override
    public CompletableFuture<Versioned<V>> putIfAbsent(K key, V value) {
        if (value == null) {
            return super.remove(key);
        }
        return super.putIfAbsent(key, value);
    }

    @Override
    public CompletableFuture<Boolean> remove(K key, V value) {
        if (value == null) {
            return CompletableFuture.completedFuture(false);
        }
        return super.remove(key, value);
    }

    @Override
    public CompletableFuture<Boolean> remove(K key, long version) {
        return super.remove(key, version);
    }

    @Override
    public CompletableFuture<Versioned<V>> replace(K key, V value) {
        if (value == null) {
            return super.remove(key);
        }
        return super.replace(key, value);
    }

    @Override
    public CompletableFuture<Boolean> replace(K key, V oldValue, V newValue) {
        if (oldValue == null) {
            return super.putIfAbsent(key, newValue).thenApply(Objects::isNull);
        } else if (newValue == null) {
            return super.remove(key, oldValue);
        }
        return super.replace(key, oldValue, newValue);
    }

    @Override
    public CompletableFuture<Boolean> replace(K key, long oldVersion, V newValue) {
        return super.replace(key, oldVersion, newValue);
    }
}