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

Modifier and Type	Field	Description
private final int	defaultPort
private final String	hostName
private final String	password
private static final char[]	PASSWORD_RESERVED
private final int	port
private final String	userName
private static final char[]	USERNAME_RESERVED

Fields inherited from interface FileName

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor	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	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 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

USERNAME_RESERVED

private static final char[] USERNAME_RESERVED

PASSWORD_RESERVED

private static final char[] PASSWORD_RESERVED

userName

private final String userName

hostName

private final String hostName

defaultPort

private final int defaultPort

password

private final String password

port

private final int port

Constructor Details

GenericFileName

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

Method Details

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).