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.cache;
25
26 import java.io.Serializable;
27 import net.jcip.annotations.Immutable;
28
29 /**
30 * The specification of how node data is to be cached. The time values provided are relative, allowing the same cache policy
31 * instance to be shared among multiple {@link Cacheable} objects.
32 */
33 @Immutable
34 public interface CachePolicy extends Serializable {
35
36 /**
37 * Get the system time in milliseconds before which the node data remains valid.
38 *
39 * @return the number of milliseconds that the cached data should be used before consulting the original source.
40 */
41 public long getTimeToLive();
42
43 }