1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.connector.path.cache;
25
26 /**
27 * This interface provides access to statistics for an individual workspace cache.
28 */
29 public interface CacheStatistics {
30
31 /**
32 * @return the number of times that a node was written to the cache
33 */
34 long getWrites();
35
36 /**
37 * @return the number of times that a node was retrieved from the cache
38 */
39 long getHits();
40
41 /**
42 * @return the number of times that an attempt to retrieve a node from the cache failed because the node was not yet in the
43 * cache.
44 */
45 long getMisses();
46
47 /**
48 * @return the number of times that an attempt to retrieve a node from the cache failed because the node had previously been
49 * placed in the cache, but the time to live for the node in the cache had expired
50 */
51 long getExpirations();
52
53 }