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.local;
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 local file URI.
27   */
28  public class LocalFileName extends AbstractFileName {
29  
30      private final String rootFile;
31  
32      protected LocalFileName(final String scheme, final String rootFile, final String path, final FileType type) {
33          super(scheme, path, type);
34          this.rootFile = rootFile;
35      }
36  
37      /**
38       * Builds the root URI for this file name.
39       */
40      @Override
41      protected void appendRootUri(final StringBuilder buffer, final boolean addPassword) {
42          buffer.append(getScheme());
43          buffer.append("://");
44          buffer.append(rootFile);
45      }
46  
47      /**
48       * Factory method for creating name instances.
49       *
50       * @param path The file path.
51       * @param type The file type.
52       * @return The FileName.
53       */
54      @Override
55      public FileName createName(final String path, final FileType type) {
56          return new LocalFileName(getScheme(), rootFile, path, type);
57      }
58  
59      /**
60       * Returns the root file for this file.
61       *
62       * @return The root file name.
63       */
64      public String getRootFile() {
65          return rootFile;
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  }