Class LayeredFileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.LayeredFileName

All Implemented Interfaces:

Comparable<FileName>, FileName

public class LayeredFileName
extends AbstractFileName

A file name for layered files.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	LAYER_SEPARATOR	The layer separator character ''!''.
private final FileName	outerUri
(package private) static final char	SCHEME_SEPARATOR

Fields inherited from interface FileName

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
LayeredFileName(String scheme, FileName outerUri, String path, FileType type)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	appendRootUri(StringBuilder buffer, boolean addPassword)	Builds the root URI for this file name.
FileName	createName(String path, FileType type)	Creates a FileName.
FileName	getOuterName()	Returns the URI of the outer file.

Methods inherited from class AbstractFileName

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

Methods inherited from class Object

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

Field Details

LAYER_SEPARATOR

public static final char LAYER_SEPARATOR

The layer separator character ''!''.

Since:

2.10.0

See Also:

• Constant Field Values

SCHEME_SEPARATOR

static final char SCHEME_SEPARATOR

See Also:

• Constant Field Values

outerUri

private final FileName outerUri

Constructor Details

LayeredFileName

public LayeredFileName(String scheme,
 FileName outerUri,
 String path,
 FileType type)

Constructs a new instance.

Parameters:

scheme - The scheme.

outerUri - outer file name.

path - the absolute path, maybe empty or null.

type - the file type.

Method Details

appendRootUri

protected void appendRootUri(StringBuilder buffer,
 boolean addPassword)

Description copied from class: AbstractFileName

Builds the root URI for this file name. Note that the root URI must not end with a separator character.

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(String path,
 FileType type)

Creates a FileName.

Specified by:

createName in class AbstractFileName

Parameters:

path - The file URI.

type - The FileType.

Returns:

The FileName.

getOuterName

public FileName getOuterName()

Returns the URI of the outer file.

Returns:

The FileName.