Package org.apache.commons.vfs2.provider.res

Class ResourceFileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.res.ResourceFileName

All Implemented Interfaces:

java.lang.Comparable<FileName>, FileName

public class ResourceFileName
extends AbstractFileName

A resource 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	ResourceFileName(java.lang.String scheme, 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	getRootURI()	Returns the root URI of the file system this file belongs to.
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, 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

ResourceFileName

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

Constructs a new instance.

Parameters:

scheme - The scheme.

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.

getRootURI

public java.lang.String getRootURI()

Description copied from class: AbstractFileName

Returns the root URI of the file system this file belongs to.

Specified by:

getRootURI in interface FileName

Overrides:

getRootURI in class AbstractFileName

Returns:

The URI of the root.

toString

public java.lang.String toString()

Returns the decoded URI of the file.

Overrides:

toString in class AbstractFileName

Returns:

the FileName as a URI.