org.apache.commons.vfs2.provider

Class GenericFileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.GenericFileName

All Implemented Interfaces:

Comparable<FileName>, FileName

Direct Known Subclasses:

GenericURLFileName, URLFileName

public class GenericFileName
extends AbstractFileName

A file name that represents a 'generic' URI, as per RFC 2396. Consists of a scheme, userinfo (typically username and password), hostname, port, and path.

Field Summary

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

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericFileName(String scheme, String hostName, int port, int defaultPort, String userName, String password, String path, FileType type)

Method Summary

Modifier and Type	Method and Description
protected void	appendCredentials(StringBuilder buffer, boolean addPassword) Append the user credentials.
protected void	appendRootUri(StringBuilder buffer, boolean addPassword) Builds the root URI for this file name.
FileName	createName(String absPath, FileType type) Create a FileName.
int	getDefaultPort() Returns the default port for this file name.
String	getHostName() Returns the host name part of this name.
String	getPassword() Returns the password part of this name.
int	getPort() Returns the port part of this name.
String	getUserName() Returns the user name part of this name.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericFileName

protected GenericFileName(String scheme,
                          String hostName,
                          int port,
                          int defaultPort,
                          String userName,
                          String password,
                          String path,
                          FileType type)

Method Detail

getUserName

public String getUserName()

Returns the user name part of this name.

Returns:

The user name.

getPassword

public String getPassword()

Returns the password part of this name.

Returns:

The password.

getHostName

public String getHostName()

Returns the host name part of this name.

Returns:

The host name.

getPort

public int getPort()

Returns the port part of this name.

Returns:

The port number.

getDefaultPort

public int getDefaultPort()

Returns the default port for this file name.

Returns:

The default port number.

createName

public FileName createName(String absPath,
                           FileType type)

Create a FileName.

Specified by:

createName in class AbstractFileName

Parameters:

absPath - The absolute path.

type - The FileType.

Returns:

The created FileName.

appendRootUri

protected void appendRootUri(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.

appendCredentials

protected void appendCredentials(StringBuilder buffer,
                                 boolean addPassword)

Append the user credentials.

If anything was added, it will be '@' terminated.

Parameters:

buffer - the string buffer to modify.

addPassword - flag if password should be added or replaced with placeholder (false).