View Javadoc

1   /*
2    * Copyright (C) 2004-2006 Christian Siefkes <christian@siefkes.net>.
3    * Development of this software is supported by the German Research Society,
4    * Berlin-Brandenburg Graduate School in Distributed Information Systems
5    * (DFG grant no. GRK 316).
6    *
7    * This program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, visit
19   * http://www.gnu.org/licenses/gpl.html or write to the Free Software
20   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21   */
22  package de.fu_berlin.ties.util;
23  
24  import java.util.Map;
25  
26  /***
27   * A pruner decidedes which map entries should be pruned (deleted), choosing
28   * among several candidate entries. Used by
29   * {@link de.fu_berlin.ties.util.AdaptableLRUMap} to realize flexible pruning
30   * strategies.
31   *
32   * @author Christian Siefkes
33   * @version $Revision: 1.5 $, $Date: 2006/10/21 16:04:27 $, $Author: siefkes $
34   */
35  public interface Pruner {
36  
37      /***
38       * Sorts an array of map entries that are candidates for being pruned
39       * (deleted).
40       *
41       * @param candidates an array of entries to be considered as candidates for
42       * pruning
43       * @return a resorted array of the entries, sorted by prunability so the
44       * entries that should be preferably pruned come first
45       */
46      Map.Entry[] sortForPruning(final Map.Entry[] candidates);
47  
48  }