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:

java.lang.Comparable<FileName>, FileName

public class GenericURLFileName
extends GenericFileName

Generic file name that represents a URL.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	BUFFER_SIZE
private java.lang.String	queryString

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

ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
GenericURLFileName(java.lang.String scheme, java.lang.String hostName, int port, int defaultPort, java.lang.String userName, java.lang.String password, java.lang.String path, FileType type, java.lang.String queryString)

Method Summary

Modifier and Type	Method and Description
FileName	createName(java.lang.String absPath, FileType type) Creates a FileName.
protected java.lang.String	createURI() Appends query string to the uri.
java.lang.String	getPathQuery() Gets the path and query string e.g.
java.lang.String	getPathQueryEncoded(java.lang.String charset) Gets the path encoded suitable for url like file system e.g.
java.lang.String	getQueryString() Gets the query string.
java.lang.String	getURIEncoded(java.lang.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, setType, toString

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

private static final int BUFFER_SIZE

See Also:

Constant Field Values

queryString

private final java.lang.String queryString

Constructor Detail

GenericURLFileName

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

Method Detail

getQueryString

public java.lang.String getQueryString()

Gets the query string.

Returns:

the query string part of the file name

getPathQuery

public java.lang.String getPathQuery()

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

Returns:

the path and its query string

getPathQueryEncoded

public java.lang.String getPathQueryEncoded(java.lang.String charset)
                                     throws java.net.URISyntaxException,
                                            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:

java.net.URISyntaxException - If an error occurs encoding the URI.

FileSystemException - If some other error occurs.

createName

public FileName createName(java.lang.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 java.lang.String createURI()

Appends query string to the uri.

Overrides:

createURI in class AbstractFileName

Returns:

the uri

getURIEncoded

public java.lang.String getURIEncoded(java.lang.String charset)
                               throws FileSystemException,
                                      java.net.URISyntaxException

Encodes a URI.

Parameters:

charset - The character set.

Returns:

The encoded URI

Throws:

FileSystemException - if some other exception occurs.

java.net.URISyntaxException - if an exception occurs encoding the URI.