org.openjdk.jmc.common.collection.EntryHashMap Maven / Gradle / Ivy
/*
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The contents of this file are subject to the terms of either the Universal Permissive License
* v 1.0 as shown at http://oss.oracle.com/licenses/upl
*
* or the following license:
*
* Redistribution and use in source and binary forms, with or without modification, are permitted
* provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other materials provided with
* the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.openjdk.jmc.common.collection;
import org.openjdk.jmc.common.collection.EntryHashMap.Entry;
/**
* A map of Entry values (containing the key and the value) that can be subclassed to allow mapping
* of mutable values. Note that the key values are final and may not be changed.
*
* @param
* key type
* @param
* value type which has a reference to its key
*/
public abstract class EntryHashMap> extends KeyInValueMap {
/**
* An entry in an EntryHashMap. Subclass to handle values.
*
* @param
* key type
*/
public abstract static class Entry {
private final K key;
/**
* Create an entry.
*
* @param key
* the key corresponding to this entry
*/
public Entry(K key) {
this.key = key;
}
/**
* Get the key.
*
* @return the key corresponding to this entry
*/
public K getKey() {
return key;
}
}
/**
* Create a new map.
*
* @param initialCapacity
* initial storage capacity
* @param loadFactor
* load factor at which to increase the internal storage capacity
*/
public EntryHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
@Override
protected K getKey(V value) {
return value.getKey();
}
}