com.gemstone.gemfire.cache.util.BoundedLinkedHashMap Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.cache.util;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* Class BoundedLinkedHashMap is a bounded
* LinkedHashMap. The bound is the maximum
* number of entries the BoundedLinkedHashMap
* can contain.
*
* @author Barry Oglesby
*
* @since 4.2
* @deprecated as of 5.7 create your own class that extends {@link LinkedHashMap}
* and implement {@link LinkedHashMap#removeEldestEntry}
* to enforce a maximum number of entries.
*/
@Deprecated
public class BoundedLinkedHashMap extends LinkedHashMap
{
private static final long serialVersionUID = -3419897166186852692L;
/**
* The maximum number of entries allowed in this
* BoundedLinkedHashMap
*/
protected int _maximumNumberOfEntries;
/**
* Constructor.
*
* @param initialCapacity The initial capacity.
* @param loadFactor The load factor
* @param maximumNumberOfEntries The maximum number of allowed entries
*/
public BoundedLinkedHashMap(int initialCapacity, float loadFactor, int maximumNumberOfEntries) {
super(initialCapacity, loadFactor);
this._maximumNumberOfEntries = maximumNumberOfEntries;
}
/**
* Constructor.
*
* @param initialCapacity The initial capacity.
* @param maximumNumberOfEntries The maximum number of allowed entries
*/
public BoundedLinkedHashMap(int initialCapacity, int maximumNumberOfEntries) {
super(initialCapacity);
this._maximumNumberOfEntries = maximumNumberOfEntries;
}
/**
* Constructor.
*
* @param maximumNumberOfEntries The maximum number of allowed entries
*/
public BoundedLinkedHashMap(int maximumNumberOfEntries) {
super();
this._maximumNumberOfEntries = maximumNumberOfEntries;
}
/**
* Returns the maximum number of entries.
* @return the maximum number of entries
*/
public int getMaximumNumberOfEntries(){
return this._maximumNumberOfEntries;
}
@Override
protected boolean removeEldestEntry(Map.Entry entry) {
return size() > this._maximumNumberOfEntries;
}
}