Package org.apache.commons.vfs2.provider

Class GenericURLFileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.GenericFileName

org.apache.commons.vfs2.provider.GenericURLFileName

All Implemented Interfaces:

Comparable<FileName>, FileName

public class GenericURLFileName
extends GenericFileName

Generic file name that represents a URL.

Field Summary

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

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
GenericURLFileName(String scheme, String hostName, int port, int defaultPort, String userName, String password, String path, FileType type, String queryString)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
FileName	createName(String absPath, FileType type)	Creates a FileName.
protected String	createURI()	Appends query string to the uri.
String	getPathQuery()	Gets the path and query string e.g.
String	getPathQueryEncoded(String charset)	Gets the path encoded suitable for url like file system e.g.
String	getQueryString()	Gets the query string.
String	getURIEncoded(String charset)	Encodes a URI.

Methods inherited from class org.apache.commons.vfs2.provider.GenericFileName

appendCredentials, appendRootUri, getDefaultPort, getHostName, getPassword, getPort, getUserName

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileName

checkName, compareTo, 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 Details

GenericURLFileName

public GenericURLFileName(String scheme,
 String hostName,
 int port,
 int defaultPort,
 String userName,
 String password,
 String path,
 FileType type,
 String queryString)

Constructs a new instance.

Parameters:

scheme - Host scheme.

hostName - Host name or IP address.

port - Host port.

defaultPort - Default host port.

userName - user name.

password - user password.

path - Path on the host.

type - File type on the host.

queryString - Query string for the path.

Method Details

createName

public FileName createName(String absPath,
 FileType type)

Creates a FileName.

Overrides:

createName in class GenericFileName

Parameters:

absPath - The absolute path.

type - The FileType.

Returns:

The FileName

createURI

protected String createURI()

Appends query string to the uri.

Overrides:

createURI in class AbstractFileName

Returns:

the uri

getPathQuery

public String getPathQuery()

Gets the path and query string e.g. /path/servlet?param1=true.

Returns:

the path and its query string

getPathQueryEncoded

public String getPathQueryEncoded(String charset)
                           throws FileSystemException

Gets the path encoded suitable for url like file system e.g. (http, webdav).

Parameters:

charset - the charset used for the path encoding

Returns:

The encoded path.

Throws:

FileSystemException - If some other error occurs.

getQueryString

public String getQueryString()

Gets the query string.

Returns:

the query string part of the file name

getURIEncoded

public String getURIEncoded(String charset)
                     throws FileSystemException

Encodes a URI.

Parameters:

charset - The character set.

Returns:

The encoded URI

Throws:

FileSystemException - if some other exception occurs.