View Javadoc
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      protected ResourceFileName(final String scheme, final String path, final FileType type) {
31          super(scheme, path, type);
32      }
33  
34  
35      /**
36       * Factory method for creating name instances.
37       *
38       * @param path The file path.
39       * @param type The file type.
40       * @return The FileName.
41       */
42      @Override
43      public FileName createName(final String path, final FileType type) {
44          return new ResourceFileName(getScheme(), path, type);
45      }
46  
47      /**
48       * Returns the decoded URI of the file.
49       *
50       * @return the FileName as a URI.
51       */
52      @Override
53      public String toString() {
54          try {
55              return UriParser.decode(super.getURI());
56          } catch (final FileSystemException e) {
57              return super.getURI();
58          }
59      }
60  
61      /**
62       * Builds the root URI for this file name.
63       */
64      @Override
65      protected void appendRootUri(final StringBuilder buffer, final boolean addPassword) {
66          buffer.append(getScheme());
67          buffer.append(":");
68      }
69  
70      @Override
71      public String getRootURI() {
72          // resource URIs have a blank root.
73          return "";
74      }
75  }