org.diorite.utils.collections.maps.ByValueSortingTreeMap.java Source code

Introduction

Here is the source code for org.diorite.utils.collections.maps.ByValueSortingTreeMap.java

Source

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016. Diorite (by Bartomiej Mazur (aka GotoFinal))
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.diorite.utils.collections.maps;

import java.util.Map;
import java.util.TreeMap;

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

import org.diorite.utils.collections.comparators.ByValueComparator;

/**
 * TreeMap sorted by values instead of keys.
 *
 * @param <K> key type.
 * @param <V> value type.
 *
 * @see TreeMap
 */
public class ByValueSortingTreeMap<K extends Comparable<K>, V extends Comparable<V>> extends TreeMap<K, V> {
    private static final long serialVersionUID = 0;
    /**
     * Comparator used by this map.
     */
    protected final ByValueComparator<K, V> comparator;

    /**
     * Construct new ByValueSortingTreeMap.
     */
    @SuppressWarnings("unchecked")
    public ByValueSortingTreeMap() {
        super(new ByValueComparator<>(true));
        this.comparator = (ByValueComparator<K, V>) this.comparator();
    }

    /**
     * Construct new ByValueSortingTreeMap with given comparator.
     *
     * @param comparator comparator to use.
     */
    public ByValueSortingTreeMap(final ByValueComparator<K, V> comparator) {
        super(comparator);
        this.comparator = comparator;
    }

    @Override
    public void putAll(final Map<? extends K, ? extends V> map) {
        this.comparator.getMap().putAll(map);
        super.putAll(map);
    }

    @Override
    public V put(final K key, final V value) {
        this.comparator.getMap().put(key, value);
        return super.put(key, value);
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).appendSuper(super.toString())
                .append("comparator", this.comparator).toString();
    }
}