View Javadoc

1   /*
2    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of 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,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.properties.spi.config.cache;
17  
18  import java.util.Set;
19  
20  /**
21   * The cache interface for all caches for smartics properties. It adds the
22   * awareness for its size and its keys.
23   *
24   * @param <K> the type variable for the key.
25   * @param <V> the type variablefor the value.
26   */
27  public interface Cache<K, V> extends UnawareCache<K, V>
28  {
29  
30    // ********************************* Fields *********************************
31  
32    // --- constants ------------------------------------------------------------
33  
34    // ****************************** Initializer *******************************
35  
36    // ****************************** Inner Classes *****************************
37  
38    // ********************************* Methods ********************************
39  
40    /**
41     * Fetch the size of the cache.
42     *
43     * @return the number of elements in the cache.
44     */
45    long size();
46  
47    /**
48     * Returns a set of all keys in the cache.
49     *
50     * @return the set of all keys.
51     */
52    Set<K> keySet();
53  
54    // --- get&set --------------------------------------------------------------
55  
56    // --- business -------------------------------------------------------------
57  
58    // --- object basics --------------------------------------------------------
59  }