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 import org.modeshape.graph.cache.CachePolicy;
27 import org.modeshape.graph.connector.path.PathNode;
28
29 /**
30 * The {@PathCachePolicy} provides a method for selectively allowing or disallowing nodes to be cached based on
31 * their size, volatility, or any other factor that can be determined for the node.
32 */
33 public interface PathCachePolicy extends CachePolicy {
34
35 /**
36 * Indicates whether the node should be cached .
37 *
38 * @param node the node that may or may not be cached; may not be null
39 * @return true if the node should be cached and false if it should not be cached
40 */
41 boolean shouldCache( PathNode node );
42
43 /**
44 * Return the class to be used as the cache implementation
45 *
46 * @return the cache class
47 */
48 Class<? extends WorkspaceCache> getCacheClass();
49 }