org.opendaylight.yangtools.util.ReadWriteTrieMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation
YANG Tools documentation
There is a newer version: 14.0.4
/*
 * Copyright (c) 2014 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.yangtools.util;

import static java.util.Objects.requireNonNull;

import com.google.common.collect.ForwardingMap;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import tech.pantheon.triemap.MutableTrieMap;
import tech.pantheon.triemap.TrieMap;

/**
 * A TrieMap facade tracking modifications. Since we change structures based on
 * their size, and determining the size of a TrieMap is expensive, we make sure
 * to update it as we go.
 *
 * 
 * FIXME: this map does not support modification view the keySet()/values()/entrySet() methods.
 *
 * @param  Key type
 * @param  Value type
 */
final class ReadWriteTrieMap extends ForwardingMap {
    private static final Logger LOG = LoggerFactory.getLogger(ReadWriteTrieMap.class);

    private final MutableTrieMap delegate;

    private int size;

    ReadWriteTrieMap() {
        this.delegate = TrieMap.create();
        this.size = 0;
    }

    ReadWriteTrieMap(final MutableTrieMap delegate, final int size) {
        this.delegate = requireNonNull(delegate);
        this.size = size;
    }

    @Override
    protected Map delegate() {
        return delegate;
    }

    Map toReadOnly() {
        final Map ret = new ReadOnlyTrieMap<>(delegate, size);
        LOG.trace("Converted read-write TrieMap {} to read-only {}", this, ret);
        return ret;
    }

    @Override
    public int size() {
        return size;
    }

    @Override
    public boolean isEmpty() {
        return size == 0;
    }

    @Override
    public V put(final K key, final V value) {
        final V ret = delegate.put(key, value);
        if (ret == null) {
            size++;
        }
        return ret;
    }

    @Override
    public V remove(final Object key) {
        final V ret = delegate.remove(key);
        if (ret != null) {
            size--;
        }
        return ret;
    }

    @Override
    @SuppressWarnings("checkstyle:parameterName")
    public void putAll(final Map m) {
        for (Entry e : m.entrySet()) {
            put(e.getKey(), e.getValue());
        }
    }

    @Override
    public void clear() {
        delegate.clear();
        size = 0;
    }

    @Override
    public Set keySet() {
        return Collections.unmodifiableSet(delegate.keySet());
    }

    @Override
    public Collection values() {
        return Collections.unmodifiableCollection(delegate.values());
    }

    @Override
    public Set> entrySet() {
        return Collections.unmodifiableSet(delegate.entrySet());
    }
}