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;
18
19 import org.apache.commons.vfs2.FileName;
20 import org.apache.commons.vfs2.FileSystemException;
21
22 /**
23 * Provides methods to parse a file name into a {@link org.apache.commons.vfs2.FileName}.
24 */
25 public interface FileNameParser {
26
27 /**
28 * Check if a character needs encoding (%nn).
29 *
30 * @param ch the character
31 * @return true if character should be encoded
32 */
33 boolean encodeCharacter(char ch);
34
35 /**
36 * Parses a String into a file name.
37 *
38 * @param context The component context.
39 * @param base The base FileName.
40 * @param uri The target file name.
41 * @return A FileName that represents the taret file.
42 * @throws FileSystemException if an error occurs parsing the URI.
43 */
44 FileName parseUri(FileNameal VfsComponentContext context, final FileName base, final String uri)
45 throws FileSystemException;
46 }