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.vfs.provider;
18  
19  import org.apache.commons.vfs.FileName;
20  import org.apache.commons.vfs.FileSystemException;
21  
22  /***
23   * Provides methods to parse a filename into a {@link org.apache.commons.vfs.FileName}
24   */
25  public interface FileNameParser
26  {
27      /***
28       * Check if a character needs encoding (%nn)
29       * @param ch the character
30       * @return true if character should be encoded
31       */
32      public boolean encodeCharacter(char ch);
33  
34      /***
35       * parses a String into a filename
36       * @param base
37       * @param filename
38       * @throws org.apache.commons.vfs.FileSystemException
39       */
40      public FileName parseUri(final VfsComponentContext context, final FileName base, final String filename) throws FileSystemException;
41  }