001    /**
002     * ================================================
003     * LibLoader : a free Java resource loading library
004     * ================================================
005     *
006     * Project Info:  http://reporting.pentaho.org/libloader/
007     *
008     * (C) Copyright 2006, by Pentaho Corporation and Contributors.
009     *
010     * This library is free software; you can redistribute it and/or modify it under the terms
011     * of the GNU Lesser General Public License as published by the Free Software Foundation;
012     * either version 2.1 of the License, or (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015     * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016     * See the GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public License along with this
019     * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020     * Boston, MA 02111-1307, USA.
021     *
022     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023     * in the United States and other countries.]
024     *
025     *
026     * ------------
027     * $Id: Resource.java 2713 2007-04-01 13:43:18Z taqua $
028     * ------------
029     * (C) Copyright 2006, by Pentaho Corporation.
030     */
031    package org.jfree.resourceloader;
032    
033    import java.io.Serializable;
034    
035    /**
036     * A resource is a wrapper around the final product. It shall not hold any
037     * references to the ResourceData object used to create the resource (to allow
038     * efficient 2-stage caching).
039     *
040     * Although this interfaces declares to be serializable, this might not be the
041     * case for some of the content contained in the resource object. Cache
042     * implementors should be aware of that issue and should act accordingly
043     * (for instance by not caching that object).
044     *
045     * @author Thomas Morgner
046     */
047    public interface Resource extends Serializable
048    {
049      public Object getResource () throws ResourceException;
050    
051      public long getVersion(ResourceKey key);
052    
053      /**
054       * The primary source is also included in this set. The dependencies are
055       * given as ResourceKey objects. The keys itself do not hold any state
056       * information.
057       *
058       * The dependencies do not track deep dependencies. So if Resource A depends
059       * on Resource B which depends on Resource C, then A only knows about B, not
060       * C.
061       *
062       * @return
063       */
064      public ResourceKey[] getDependencies();
065      public ResourceKey getSource();
066    }