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  import lombok.EqualsAndHashCode;
42  
43  /**
44   * A convenient class to extend by subclasses of {@link AbstractResourceOrigin}. Subclasses merely need to expose a constructor
45   * for the {@link ResourceOrigin} to use, and a method to let it retrieve the underlying resource object.
46   *
47   * @see AbstractResourceOrigin
48   */
49  @EqualsAndHashCode
50  public abstract class AbstractResource implements Resource {
51      private final AbstractResourceOrigin origin;
52  
53      protected AbstractResource(AbstractResourceOrigin origin) {
54          this.origin = origin;
55      }
56  
57      @Override
58      public ResourceOrigin getOrigin() {
59          return origin;
60      }
61  
62      @Override
63      public boolean isFile() {
64          return origin.isFile(this);
65      }
66  
67      @Override
68      public boolean isDirectory() {
69          return origin.isDirectory(this);
70      }
71  
72      @Override
73      public boolean isEditable() {
74          return origin.isEditable(this);
75      }
76  
77      @Override
78      public String getPath() {
79          return origin.getPath(this);
80      }
81  
82      @Override
83      public String getName() {
84          return origin.getName(this);
85      }
86  
87      @Override
88      public long getLastModified() {
89          return origin.getLastModified(this);
90      }
91  
92      @Override
93      public List<Resource> listChildren() {
94          return origin.listChildren(this);
95      }
96  
97      @Override
98      public Resource getParent() {
99          return origin.getParent(this);
100     }
101 
102     @Override
103     public InputStream openStream() throws IOException {
104         return origin.openStream(this);
105     }
106 
107     @Override
108     public Reader openReader() throws IOException {
109         return origin.openReader(this);
110     }
111 
112     @Override
113     public String toString() {
114         return this.getClass().getSimpleName() + "{" +
115                 "origin=" + origin.getName() + "," +
116                 "path=" + getPath() + "," +
117                 (isDirectory() ? "(directory)" : "file") +
118                 '}';
119     }
120 
121 }