View Javadoc
1   /**
2    * This file Copyright (c) 2015-2016 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.resourceloader;
35  
36  import java.io.IOException;
37  import java.io.InputStream;
38  import java.io.Reader;
39  import java.util.List;
40  
41  /**
42   * The Resource is a common specific type for dealing with resources uniformly across arbitrary {@link ResourceOrigin}s.
43   *
44   * Note that {@link ResourceOrigin} doesn't guarantee to always return the same Resource instance for an arbitrary path,
45   * therefore implementors are responsible for providing meaningful {@link #equals(Object) equals} and {@link #hashCode() hashCode} methods here.
46   */
47  public interface Resource {
48  
49      ResourceOrigin getOrigin();
50  
51      boolean isFile();
52  
53      boolean isDirectory();
54  
55      /**
56       * Determines whether this resource can be edited in its underlying origin.
57       */
58      boolean isEditable();
59  
60      /**
61       * Returns the "absolute" path to this resource. Depending on the implementation, it might in effect be relative
62       * to some other root path, but the user of this package should consider them absolute.
63       */
64      // TODO do we even need this method next to a "describe()" method ?
65      // Because Resource should hold info about ResourceOrigin. -> add OriginDescriptor or some such");
66      String getPath();
67  
68      String getName();
69  
70      /**
71       * Returns the last modification date of this resource as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
72       * @see java.util.Date#getTime()
73       */
74      long getLastModified();
75  
76      Resource getParent();
77  
78      List<Resource> listChildren();
79  
80      /**
81       * Opens an {@link InputStream} for this resource. Client code is expected to close the stream.
82       * @see #openReader()
83       */
84      InputStream openStream() throws IOException;
85  
86      /**
87       * Opens a {@link Reader} for this resource; if the associated {@link ResourceOrigin} can guess it, this will have been
88       * opened with the corrected encoding. Client code is expected to close the reader.
89       * @see #openStream()
90       */
91      Reader openReader() throws IOException;
92  
93  }