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

Modifier and Type	Field and Description
private static char[]	RESERVED_URI_CHARS
private java.lang.String	rootFile

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

ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalFileName(java.lang.String scheme, java.lang.String rootFile, java.lang.String path, FileType type)

Method Summary

Modifier and Type	Method and 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	getFriendlyURI() returns a "friendly path", this is a path without a password.
java.lang.String	getRootFile() Returns the root file for this file.
java.lang.String	getURI() Returns the absolute URI of the 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, getParent, getPath, getPathDecoded, getRelativeName, getRoot, getRootURI, getScheme, getType, getUriTrailer, hashCode, isAncestor, isDescendent, isDescendent, isFile

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_URI_CHARS

private static final char[] RESERVED_URI_CHARS

rootFile

private final java.lang.String rootFile

Constructor Detail

LocalFileName

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

Method Detail

getRootFile

public java.lang.String getRootFile()

Returns the root file for this file.

Returns:

The root file name.

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.

getURI

public java.lang.String getURI()

Returns the absolute URI of the file.

Specified by:

getURI in interface FileName

Overrides:

getURI in class AbstractFileName

Returns:

The absolute URI of the file.

getFriendlyURI

public java.lang.String getFriendlyURI()

returns a "friendly path", this is a path without a password.

Specified by:

getFriendlyURI in interface FileName

Overrides:

getFriendlyURI in class AbstractFileName

Returns:

The "friendly" URI.

toString

public java.lang.String toString()

Returns the decoded URI of the file.

Overrides:

toString in class AbstractFileName

Returns:

the FileName as a URI.

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.