01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * Check if a character needs encoding (%nn)
28: * @param ch the character
29: * @return true if character should be encoded
30: */
31: public boolean encodeCharacter(char ch);
32:
33: /**
34: * parses a String into a filename
35: * @param base
36: * @param filename
37: * @throws org.apache.commons.vfs.FileSystemException
38: */
39: public FileName parseUri(final VfsComponentContext context,
40: final FileName base, final String filename)
41: throws FileSystemException;
42: }
|