1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.vfs2.provider.res;
18
19 import org.apache.commons.vfs2.FileName;
20 import org.apache.commons.vfs2.FileSystemException;
21 import org.apache.commons.vfs2.FileType;
22 import org.apache.commons.vfs2.provider.AbstractFileName;
23 import org.apache.commons.vfs2.provider.UriParser;
24
25 /**
26 * A resource file URI.
27 */
28 public class ResourceFileName extends AbstractFileName {
29
30 /**
31 * Constructs a new instance.
32 *
33 * @param scheme The scheme.
34 * @param path the absolute path, maybe empty or null.
35 * @param type the file type.
36 */
37 protected ResourceFileName(final String scheme, final String path, final FileType type) {
38 super(scheme, path, type);
39 }
40
41 /**
42 * Builds the root URI for this file name.
43 */
44 @Override
45 protected void appendRootUri(final StringBuilder buffer, final boolean addPassword) {
46 buffer.append(getScheme());
47 buffer.append(":");
48 }
49
50 /**
51 * Factory method for creating name instances.
52 *
53 * @param path The file path.
54 * @param type The file type.
55 * @return The FileName.
56 */
57 @Override
58 public FileName createName(final String path, final FileType type) {
59 return new ResourceFileName(getScheme(), path, type);
60 }
61
62 @Override
63 public String getRootURI() {
64 // resource URIs have a blank root.
65 return "";
66 }
67
68 /**
69 * Returns the decoded URI of the file.
70 *
71 * @return the FileName as a URI.
72 */
73 @Override
74 public String toString() {
75 try {
76 return UriParser.decode(super.getURI());
77 } catch (final FileSystemException e) {
78 return super.getURI();
79 }
80 }
81 }