org.apache.commons.vfs2.provider

Interface FileNameParser

All Known Implementing Classes:

AbstractFileNameParser, FtpFileNameParser, GenericFileNameParser, HostFileNameParser, HttpFileNameParser, HttpsFileNameParser, LayeredFileNameParser, LocalFileNameParser, SftpFileNameParser, UrlFileNameParser, URLFileNameParser, WebdavFileNameParser, WindowsFileNameParser

public interface FileNameParser

Provides methods to parse a filename into a FileName.

Author:

Commons VFS team

Method Summary

Modifier and Type	Method and Description
boolean	encodeCharacter(char ch) Check if a character needs encoding (%nn).
FileName	parseUri(VfsComponentContext context, FileName base, String filename) parses a String into a filename.

Method Detail

encodeCharacter

boolean encodeCharacter(char ch)

Check if a character needs encoding (%nn).

Parameters:

ch - the character

Returns:

true if character should be encoded

parseUri

FileName parseUri(VfsComponentContext context,
                  FileName base,
                  String filename)
           throws FileSystemException

parses a String into a filename.

Parameters:

context - The component context.

base - The base FileName.

filename - The target file name.

Returns:

A FileName that represents the taret file.

Throws:

FileSystemException - if an error occurs parsing the URI.