Class GenericFileName

  • All Implemented Interfaces:
    java.lang.Comparable<FileName>, FileName
    Direct Known Subclasses:
    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.
    • Constructor Detail

      • GenericFileName

        protected GenericFileName​(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)
    • Method Detail

      • getUserName

        public java.lang.String getUserName()
        Returns the user name part of this name.
        Returns:
        The user name.
      • getPassword

        public java.lang.String getPassword()
        Returns the password part of this name.
        Returns:
        The password.
      • getHostName

        public java.lang.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.
      • appendRootUri

        protected void appendRootUri​(java.lang.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​(java.lang.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).