org.opendaylight.mdsal.dom.spi.DOMDataTreePrefixTable Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.mdsal.dom.spi;

import com.google.common.annotations.Beta;
import java.util.EnumMap;
import java.util.Map;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Prefix table indexed by {@link DOMDataTreeIdentifier}. Stores values in tree and provides lookup of closest ancestor.
 * This class is not thread-safe.
 *
 * @param  Value type
 */
@Beta
public final class DOMDataTreePrefixTable {
    private static final Logger LOG = LoggerFactory.getLogger(DOMDataTreePrefixTable.class);

    private final Map> roots =
        new EnumMap<>(LogicalDatastoreType.class);

    private DOMDataTreePrefixTable() {
        // Hidden in purpose
    }

    public static  DOMDataTreePrefixTable create() {
        return new DOMDataTreePrefixTable<>();
    }

    /**
     * Lookups entry by provided {@link DOMDataTreeIdentifier}, if entry is not present returns
     * closest non-null entry towards root or null if no entry towards root exists.
     *
     * @param prefix Prefix for lookup
     * @return closest non-null entry towards root or null if no entry towards root exists.
     */
    public @Nullable DOMDataTreePrefixTableEntry lookup(final @NonNull DOMDataTreeIdentifier prefix) {
        final var entryt = roots.get(prefix.datastore());
        return entryt == null ? null : entryt.lookup(prefix.path());
    }

    /**
     * Stores value associated to the prefix.
     *
     * @param prefix DOM prefix of value
     * @param value Value to be stored
     * @throws IllegalStateException If value is already stored for provided prefix
     */
    public void store(final @NonNull DOMDataTreeIdentifier prefix, final @NonNull V value) {
        var domDataTreePrefixTableEntry = roots.get(prefix.datastore());
        if (domDataTreePrefixTableEntry == null) {
            domDataTreePrefixTableEntry = new DOMDataTreePrefixTableEntry<>();
            roots.put(prefix.datastore(), domDataTreePrefixTableEntry);
        }

        domDataTreePrefixTableEntry.store(prefix.path(), value);
    }

    /**
     * Removes value associated to the prefix.
     * Value is removed only and only if full prefix match for stored value. Removal of prefix does
     * not remove child prefixes.
     *
     * @param prefix to be removed
     */
    public void remove(final @NonNull DOMDataTreeIdentifier prefix) {
        final var entry = roots.get(prefix.datastore());
        if (entry == null) {
            LOG.warn("Shard registration {} points to non-existent table", prefix);
            return;
        }

        entry.remove(prefix.path());
    }
}