Package org.apache.commons.vfs2.provider.local

Class LocalFileNameParser

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileNameParser

org.apache.commons.vfs2.provider.local.LocalFileNameParser

All Implemented Interfaces:

FileNameParser

Direct Known Subclasses:

GenericFileNameParser, WindowsFileNameParser

public abstract class LocalFileNameParser
extends AbstractFileNameParser

A name parser.

Constructor Summary

Constructors

Constructor	Description
LocalFileNameParser()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract FileName	createFileName(java.lang.String scheme, java.lang.String rootFile, java.lang.String path, FileType fileType)	Creates a FileName.
protected abstract java.lang.String	extractRootPrefix(java.lang.String uri, java.lang.StringBuilder name)	Pops the root prefix off a URI, which has had the scheme removed.
boolean	isAbsoluteName(java.lang.String name)	Determines if a name is an absolute file name.
FileName	parseUri(VfsComponentContext context, FileName base, java.lang.String uri)	Parses a String into a file name.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileNameParser

encodeCharacter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalFileNameParser

public LocalFileNameParser()

Constructs a new instance.

Method Detail

createFileName

protected abstract FileName createFileName(java.lang.String scheme,
                                           java.lang.String rootFile,
                                           java.lang.String path,
                                           FileType fileType)

Creates a FileName.

Parameters:

scheme - The scheme.

rootFile - the root file.

path - the path.

fileType - the file type.

Returns:

a FileName.

extractRootPrefix

protected abstract java.lang.String extractRootPrefix(java.lang.String uri,
                                                      java.lang.StringBuilder name)
                                               throws FileSystemException

Pops the root prefix off a URI, which has had the scheme removed.

Parameters:

name - the URI to modify.

uri - the whole URI for error reporting.

Returns:

the root prefix extracted.

Throws:

FileSystemException - if an error occurs.

isAbsoluteName

public boolean isAbsoluteName(java.lang.String name)

Determines if a name is an absolute file name.

Parameters:

name - The file name.

Returns:

true if the name is absolute, false otherwise.

parseUri

public FileName parseUri(VfsComponentContext context,
                         FileName base,
                         java.lang.String uri)
                  throws FileSystemException

Description copied from interface: FileNameParser

Parses a String into a file name.

Parameters:

context - The component context.

base - The base FileName.

uri - The target file name.

Returns:

A FileName that represents the taret file.

Throws:

FileSystemException - if an error occurs parsing the URI.