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

Class LocalFileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.local.LocalFileName

All Implemented Interfaces:

java.lang.Comparable<FileName>, FileName

Direct Known Subclasses:

WindowsFileName

public class LocalFileName
extends AbstractFileName

A local file URI.

Field Summary

Fields inherited from interface org.apache.commons.vfs2.FileName

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocalFileName(java.lang.String scheme, java.lang.String rootFile, java.lang.String path, FileType type)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	appendRootUri(java.lang.StringBuilder buffer, boolean addPassword)	Builds the root URI for this file name.
FileName	createName(java.lang.String path, FileType type)	Factory method for creating name instances.
java.lang.String	getRootFile()	Returns the root file for this file.
java.lang.String	toString()	Returns the decoded URI of the file.

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

checkName, compareTo, createURI, equals, getBaseName, getDepth, getExtension, getFriendlyURI, getParent, getPath, getPathDecoded, getRelativeName, getRoot, getRootURI, getScheme, getType, getURI, getUriTrailer, hashCode, isAncestor, isDescendent, isDescendent, isFile

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalFileName

protected LocalFileName(java.lang.String scheme,
                        java.lang.String rootFile,
                        java.lang.String path,
                        FileType type)

Constructs a new instance.

Parameters:

scheme - the scheme.

rootFile - the root file.

path - the absolute path, maybe empty or null.

type - the file type.

Method Detail

appendRootUri

protected void appendRootUri(java.lang.StringBuilder buffer,
                             boolean addPassword)

Builds the root URI for this file name.

Specified by:

appendRootUri in class AbstractFileName

Parameters:

buffer - A StringBuilder to use to construct the URI.

addPassword - true if the password should be added, false otherwise.

createName

public FileName createName(java.lang.String path,
                           FileType type)

Factory method for creating name instances.

Specified by:

createName in class AbstractFileName

Parameters:

path - The file path.

type - The file type.

Returns:

The FileName.

getRootFile

public java.lang.String getRootFile()

Returns the root file for this file.

Returns:

The root file name.

toString

public java.lang.String toString()

Returns the decoded URI of the file.

Overrides:

toString in class AbstractFileName

Returns:

the FileName as a URI.