Class AbstractFileName

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractFileName​(java.lang.String scheme, java.lang.String absolutePath, FileType type)
      Constructs a new instance for subclasses.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract void appendRootUri​(java.lang.StringBuilder buffer, boolean addPassword)
      Builds the root URI for this file name.
      static boolean checkName​(java.lang.String basePath, java.lang.String path, NameScope scope)
      Checks whether a path fits in a particular scope of another path.
      int compareTo​(FileName obj)
      Implement Comparable.
      abstract FileName createName​(java.lang.String absolutePath, FileType fileType)
      Factory method for creating name instances.
      protected java.lang.String createURI()
      Creates a URI.
      boolean equals​(java.lang.Object o)  
      java.lang.String getBaseName()
      Returns the base name of the file.
      int getDepth()
      Returns the depth of this file name, within its file system.
      java.lang.String getExtension()
      Returns the extension of this file name.
      java.lang.String getFriendlyURI()
      Returns the URI without a password.
      FileName getParent()
      Returns the name of the parent of the file.
      java.lang.String getPath()
      Returns the absolute path of the file, relative to the root of the file system that the file belongs to.
      java.lang.String getPathDecoded()
      Returns the decoded path.
      java.lang.String getRelativeName​(FileName name)
      Converts a file name to a relative name, relative to this file name.
      FileName getRoot()
      find the root of the file system.
      java.lang.String getRootURI()
      Returns the root URI of the file system this file belongs to.
      java.lang.String getScheme()
      Returns the URI scheme of this file.
      FileType getType()
      Returns the requested or current type of this name.
      java.lang.String getURI()
      Returns the absolute URI of the file.
      protected java.lang.String getUriTrailer()
      Gets the string to end a URI.
      int hashCode()  
      boolean isAncestor​(FileName ancestor)
      Determines if another file name is an ancestor of this file name.
      boolean isDescendent​(FileName descendent)
      Determines if another file name is a descendent of this file name.
      boolean isDescendent​(FileName descendent, NameScope scope)
      Determines if another file name is a descendent of this file name.
      boolean isFile()
      Checks if this file name is a name for a regular file by using its type.
      java.lang.String toString()
      Returns the URI of the file.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AbstractFileName

        public AbstractFileName​(java.lang.String scheme,
                                java.lang.String absolutePath,
                                FileType type)
        Constructs a new instance for subclasses.
        Parameters:
        scheme - The scheme.
        absolutePath - the absolute path, maybe empty or null.
        type - the file type.
    • Method Detail

      • checkName

        public static boolean checkName​(java.lang.String basePath,
                                        java.lang.String path,
                                        NameScope scope)
        Checks whether a path fits in a particular scope of another path.
        Parameters:
        basePath - An absolute, normalized path.
        path - An absolute, normalized path.
        scope - The NameScope.
        Returns:
        true if the path fits in the scope, false otherwise.
      • appendRootUri

        protected abstract void appendRootUri​(java.lang.StringBuilder buffer,
                                              boolean addPassword)
        Builds the root URI for this file name. Note that the root URI must not end with a separator character.
        Parameters:
        buffer - A StringBuilder to use to construct the URI.
        addPassword - true if the password should be added, false otherwise.
      • compareTo

        public int compareTo​(FileName obj)
        Implement Comparable.
        Specified by:
        compareTo in interface java.lang.Comparable<FileName>
        Parameters:
        obj - another abstract file name
        Returns:
        negative number if less than, 0 if equal, positive if greater than.
      • createName

        public abstract FileName createName​(java.lang.String absolutePath,
                                            FileType fileType)
        Factory method for creating name instances.
        Parameters:
        absolutePath - The absolute path.
        fileType - The FileType.
        Returns:
        The FileName.
      • createURI

        protected java.lang.String createURI()
        Creates a URI.
        Returns:
        a URI.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • getBaseName

        public java.lang.String getBaseName()
        Returns the base name of the file.
        Specified by:
        getBaseName in interface FileName
        Returns:
        The base name of the file.
      • getDepth

        public int getDepth()
        Returns the depth of this file name, within its file system.
        Specified by:
        getDepth in interface FileName
        Returns:
        The depth of the file name.
      • getExtension

        public java.lang.String getExtension()
        Returns the extension of this file name.
        Specified by:
        getExtension in interface FileName
        Returns:
        The file extension.
      • getFriendlyURI

        public java.lang.String getFriendlyURI()
        Returns the URI without a password.
        Specified by:
        getFriendlyURI in interface FileName
        Returns:
        Returns the URI without a password.
      • getParent

        public FileName getParent()
        Returns the name of the parent of the file.
        Specified by:
        getParent in interface FileName
        Returns:
        the FileName of the parent.
      • getPath

        public java.lang.String getPath()
        Returns the absolute path of the file, relative to the root of the file system that the file belongs to.
        Specified by:
        getPath in interface FileName
        Returns:
        The path String.
      • getRootURI

        public java.lang.String getRootURI()
        Returns the root URI of the file system this file belongs to.
        Specified by:
        getRootURI in interface FileName
        Returns:
        The URI of the root.
      • getScheme

        public java.lang.String getScheme()
        Returns the URI scheme of this file.
        Specified by:
        getScheme in interface FileName
        Returns:
        The protocol used to access the file.
      • getURI

        public java.lang.String getURI()
        Returns the absolute URI of the file.
        Specified by:
        getURI in interface FileName
        Returns:
        The absolute URI of the file.
      • getUriTrailer

        protected java.lang.String getUriTrailer()
        Gets the string to end a URI.
        Returns:
        the string to end a URI
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • isAncestor

        public boolean isAncestor​(FileName ancestor)
        Determines if another file name is an ancestor of this file name.
        Specified by:
        isAncestor in interface FileName
        Parameters:
        ancestor - The FileName to check.
        Returns:
        true if the FileName is an ancestor, false otherwise.
      • isDescendent

        public boolean isDescendent​(FileName descendent)
        Determines if another file name is a descendent of this file name.
        Specified by:
        isDescendent in interface FileName
        Parameters:
        descendent - The FileName to check.
        Returns:
        true if the FileName is a descendent, false otherwise.
      • isDescendent

        public boolean isDescendent​(FileName descendent,
                                    NameScope scope)
        Determines if another file name is a descendent of this file name.
        Specified by:
        isDescendent in interface FileName
        Parameters:
        descendent - The FileName to check.
        scope - The NameScope.
        Returns:
        true if the FileName is a descendent, false otherwise.
      • toString

        public java.lang.String toString()
        Returns the URI of the file.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the FileName as a URI.