1 /**
2 * This file Copyright (c) 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 * {@linkplain Resource} placeholder. Typical purpose of an instance of this class is e.g. to represent a resource which
43 * does not already exist (e.g. after deletion) letting {@link ResourceVisitor ResourceVisitors} to handle such a case
44 * accordingly.
45 * <p>
46 * <strong>NOTE:</strong> this class doesn't not support any {@link Resource} operation and will throw an {@link UnsupportedOperationException}
47 * on any attempt to use its API <strong>except for {@link Resource#getPath()}</strong>.
48 * </p>
49 *
50 * For a typical (albeit implicit) use case of a {@link ResourceStub} - see {@link info.magnolia.resourceloader.layered.RelayerResourceVisitor RelayerResourceVisitor}
51 */
52 public class ResourceStub implements Resource {
53
54 private final String path;
55
56 private ResourceStub(String path) {
57 this.path = path;
58 }
59
60 public static ResourceStub withPath(String path) {
61 return new ResourceStub(path);
62 }
63
64 @Override
65 public String getPath() {
66 return path;
67 }
68
69 @Override
70 public ResourceOrigin getOrigin() {
71 throw new UnsupportedOperationException();
72 }
73
74 @Override
75 public boolean isFile() {
76 return true;
77 }
78
79 @Override
80 public boolean isDirectory() {
81 return false;
82 }
83
84 @Override
85 public boolean isEditable() {
86 throw new UnsupportedOperationException();
87 }
88
89 @Override
90 public String getName() {
91 throw new UnsupportedOperationException();
92 }
93
94 @Override
95 public long getLastModified() {
96 throw new UnsupportedOperationException();
97 }
98
99 @Override
100 public Resource getParent() {
101 throw new UnsupportedOperationException();
102 }
103
104 @Override
105 public List<Resource> listChildren() {
106 throw new UnsupportedOperationException();
107 }
108
109 @Override
110 public InputStream openStream() throws IOException {
111 throw new UnsupportedOperationException();
112 }
113
114 @Override
115 public Reader openReader() throws IOException {
116 throw new UnsupportedOperationException();
117 }
118 }