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 org.modeshape.graph.property.DateTime; 28 29 /** 30 * Interface defining an object that can be cached according to a {@link CachePolicy}. 31 */ 32 public interface Cacheable extends Serializable { 33 34 /** 35 * Get the time that this node data was originally loaded. 36 * 37 * @return the system time (in milliseconds) that the node data was loaded 38 */ 39 DateTime getTimeLoaded(); 40 41 /** 42 * Get the caching policy to be used for this object. 43 * <p> 44 * Note that the values of the policy are relative to the {@link #getTimeLoaded() time the node was loaded}, so the same 45 * instance can be used for many nodes. 46 * </p> 47 * 48 * @return cachePolicy the caching policy, which may not be null 49 */ 50 public CachePolicy getCachePolicy(); 51 52 /** 53 * Set the caching policy for this object. 54 * 55 * @param cachePolicy the caching policy to use for this object 56 * @throws IllegalArgumentException if the cachePolicy is null 57 */ 58 public void setCachePolicy( CachePolicy cachePolicy ); 59 60 }