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:
- GenericURLFileName,- 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 SummaryFields inherited from interface org.apache.commons.vfs2.FileNameEMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidappendCredentials(StringBuilder buffer, boolean addPassword) Append the user credentials.protected voidappendRootUri(StringBuilder buffer, boolean addPassword) Builds the root URI for this file name.createName(String absPath, FileType type) Create a FileName.intReturns the default port for this file name.Returns the host name part of this name.Returns the password part of this name.intgetPort()Returns the port part of this name.Returns the user name part of this name.Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileNamecheckName, 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- 
GenericFileNameprotected GenericFileName(String scheme, String hostName, int port, int defaultPort, String userName, String password, String path, FileType type) Constructs a new instance.- Parameters:
- scheme- the scheme.
- hostName- the host name.
- port- the port.
- defaultPort- the default port.
- userName- the user name.
- password- the password.
- path- the absolute path, maybe empty or null.
- type- the file type.
 
 
- 
- 
Method Details- 
appendCredentialsAppend 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).
 
- 
appendRootUriBuilds the root URI for this file name.- Specified by:
- appendRootUriin class- AbstractFileName
- Parameters:
- buffer- A StringBuilder to use to construct the URI.
- addPassword- true if the password should be added, false otherwise.
 
- 
createNameCreate a FileName.- Specified by:
- createNamein class- AbstractFileName
- Parameters:
- absPath- The absolute path.
- type- The FileType.
- Returns:
- The created FileName.
 
- 
getDefaultPortReturns the default port for this file name.- Returns:
- The default port number.
 
- 
getHostNameReturns the host name part of this name.- Returns:
- The host name.
 
- 
getPasswordReturns the password part of this name.- Returns:
- The password.
 
- 
getPortReturns the port part of this name.- Returns:
- The port number.
 
- 
getUserNameReturns the user name part of this name.- Returns:
- The user name.
 
 
-