Package 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:
URLFileName
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
ROOT_PATH, SEPARATOR, SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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.createName
(String absPath, FileType type) Create a FileName.int
Returns the default port for this file name.Returns the host name part of this name.Returns the password part of this name.int
getPort()
Returns the port part of this name.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
-
Constructor Details
-
GenericFileName
-
-
Method Details
-
getUserName
Returns the user name part of this name.- Returns:
- The user name.
-
getPassword
Returns the password part of this name.- Returns:
- The password.
-
getHostName
Returns the host name part of this name.- Returns:
- The host name.
-
getPort
Returns the port part of this name.- Returns:
- The port number.
-
getDefaultPort
Returns the default port for this file name.- Returns:
- The default port number.
-
createName
Create a FileName.- Specified by:
createName
in classAbstractFileName
- Parameters:
absPath
- The absolute path.type
- The FileType.- Returns:
- The created FileName.
-
appendRootUri
Builds the root URI for this file name.- Specified by:
appendRootUri
in classAbstractFileName
- Parameters:
buffer
- A StringBuilder to use to construct the URI.addPassword
- true if the password should be added, false otherwise.
-
appendCredentials
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).
-