1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5 * use this file except in compliance with the License. You may obtain a copy of
6 * the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations under
14 * the License.
15 */
16
17package com.android.inputmethod.latin;
18
19import com.android.inputmethod.latin.SuggestedWords.SuggestedWordInfo;
20
21import java.util.Collection;
22import java.util.Comparator;
23import java.util.TreeSet;
24
25/**
26 * A TreeSet that is bounded in size and throws everything that's smaller than its limit
27 */
28public final class BoundedTreeSet extends TreeSet<SuggestedWordInfo> {
29    private final int mCapacity;
30    public BoundedTreeSet(final Comparator<SuggestedWordInfo> comparator, final int capacity) {
31        super(comparator);
32        mCapacity = capacity;
33    }
34
35    @Override
36    public boolean add(final SuggestedWordInfo e) {
37        if (size() < mCapacity) return super.add(e);
38        if (comparator().compare(e, last()) > 0) return false;
39        super.add(e);
40        pollLast(); // removes the last element
41        return true;
42    }
43
44    @Override
45    public boolean addAll(final Collection<? extends SuggestedWordInfo> e) {
46        if (null == e) return false;
47        return super.addAll(e);
48    }
49}
50