KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > vfs > provider > FileNameParser


1 /*
2  * Copyright 2002-2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */

16 package org.apache.commons.vfs.provider;
17
18 import org.apache.commons.vfs.FileName;
19 import org.apache.commons.vfs.FileSystemException;
20
21 /**
22  * Provides methods to parse a filename into a {@link org.apache.commons.vfs.FileName}
23  */

24 public interface FileNameParser
25 {
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      * @return
38      * @throws org.apache.commons.vfs.FileSystemException
39      */

40     public FileName parseUri(final VfsComponentContext context, final FileName base, final String JavaDoc filename) throws FileSystemException;
41 }
42
Popular Tags