Source for org.jfree.resourceloader.Resource

   1: /**
   2:  * ================================================
   3:  * LibLoader : a free Java resource loading library
   4:  * ================================================
   5:  *
   6:  * Project Info:  http://reporting.pentaho.org/libloader/
   7:  *
   8:  * (C) Copyright 2006, by Pentaho Corporation and Contributors.
   9:  *
  10:  * This library is free software; you can redistribute it and/or modify it under the terms
  11:  * of the GNU Lesser General Public License as published by the Free Software Foundation;
  12:  * either version 2.1 of the License, or (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  15:  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16:  * See the GNU Lesser General Public License for more details.
  17:  *
  18:  * You should have received a copy of the GNU Lesser General Public License along with this
  19:  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20:  * Boston, MA 02111-1307, USA.
  21:  *
  22:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  23:  * in the United States and other countries.]
  24:  *
  25:  *
  26:  * ------------
  27:  * $Id: Resource.java,v 1.4 2007/04/01 13:43:17 taqua Exp $
  28:  * ------------
  29:  * (C) Copyright 2006, by Pentaho Corporation.
  30:  */
  31: package org.jfree.resourceloader;
  32: 
  33: import java.io.Serializable;
  34: 
  35: /**
  36:  * A resource is a wrapper around the final product. It shall not hold any
  37:  * references to the ResourceData object used to create the resource (to allow
  38:  * efficient 2-stage caching).
  39:  *
  40:  * Although this interfaces declares to be serializable, this might not be the
  41:  * case for some of the content contained in the resource object. Cache
  42:  * implementors should be aware of that issue and should act accordingly
  43:  * (for instance by not caching that object).
  44:  *
  45:  * @author Thomas Morgner
  46:  */
  47: public interface Resource extends Serializable
  48: {
  49:   public Object getResource () throws ResourceException;
  50: 
  51:   public long getVersion(ResourceKey key);
  52: 
  53:   /**
  54:    * The primary source is also included in this set. The dependencies are
  55:    * given as ResourceKey objects. The keys itself do not hold any state
  56:    * information.
  57:    *
  58:    * The dependencies do not track deep dependencies. So if Resource A depends
  59:    * on Resource B which depends on Resource C, then A only knows about B, not
  60:    * C.
  61:    *
  62:    * @return
  63:    */
  64:   public ResourceKey[] getDependencies();
  65:   public ResourceKey getSource();
  66: }