1 /**
2 * This file Copyright (c) 2015 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.classpath;
35
36 import info.magnolia.resourceloader.AbstractResource;
37
38 import java.util.List;
39
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42
43 import lombok.EqualsAndHashCode;
44
45 /**
46 * A {@link info.magnolia.resourceloader.Resource Resource} for {@link ClasspathResourceOrigin}.
47 * @see ClasspathResourceOrigin
48 */
49 @EqualsAndHashCode(callSuper = true)
50 public class ClasspathResource extends AbstractResource {
51
52 private static final Logger log = LoggerFactory.getLogger(ClasspathResource.class);
53
54 private final String realPath;
55 private final boolean isFile;
56
57 ClasspathResource(ClasspathResourceOrigin origin, String path, boolean isFile) {
58 super(origin);
59 if (!path.startsWith("/")) {
60 throw new IllegalArgumentException("Path does not start with /: " + path);
61 }
62 this.realPath = path;
63 this.isFile = isFile;
64 }
65
66 String getRealPath() {
67 return realPath;
68 }
69
70 @Override
71 public boolean isFile() {
72 return isFile;
73 }
74
75 @Override
76 public boolean isDirectory() {
77 return !isFile;
78 }
79
80 @Override
81 public ClasspathResource getParent() {
82 return (ClasspathResource) super.getParent();
83 }
84
85 /**
86 * @deprecated since 5.4.4 without replacement
87 */
88 @Deprecated
89 void setParent(ClasspathResource ignored) {
90 log.warn("This method should not be used, it will not have any effects");
91 }
92
93 /**
94 * @deprecated since 5.4.4 without replacement
95 */
96 @Deprecated
97 public void setChildren(List<ClasspathResource> ignored) {
98 log.warn("This method should not be used, it will not have any effects");
99 }
100
101 /**
102 * @deprecated since 5.4.4 without replacement
103 */
104 @Deprecated
105 public void addChild(ClasspathResource ignored) {
106 log.warn("This method should not be used, it will not have any effects");
107 }
108 }