Package io.virtdata.docsys.metafs.core

Class MetaPath

  • All Implemented Interfaces:
    java.lang.Comparable<java.nio.file.Path>, java.lang.Iterable<java.nio.file.Path>, java.nio.file.Path, java.nio.file.Watchable
    public class MetaPath
extends java.lang.Object
implements java.nio.file.Path
    A MetaPath represent a logical path for one of any MetaFS derivatives. A MetaPath is meant to be filesystem provider agnostic in terms of the path syntax. Internally, the MetaPath syntax sill defer to the default FileSystem provider's syntax.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String[] path  

    • Constructor Summary

      Constructors 
      Constructor Description
      MetaPath​(MetaFS metaFS, java.lang.String[] components, boolean absolute)  
      MetaPath​(MetaFS metaFS, java.lang.String initial, java.lang.String... remaining)  

    • Method Summary

      Modifier and Type Method Description
      MetaPath asRelativePath()  
      int compareTo​(java.nio.file.Path other)  
      boolean endsWith​(java.nio.file.Path other)  
      boolean equals​(java.lang.Object o)  
      java.nio.file.Path getFileName()  
      MetaFS getFileSystem()  
      java.nio.file.Path getName​(int index)  
      int getNameCount()  
      java.nio.file.Path getParent()  
      java.nio.file.Path getRoot()  
      int hashCode()  
      boolean isAbsolute()  
      java.nio.file.Path normalize()  
      java.nio.file.WatchKey register​(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>[] events, java.nio.file.WatchEvent.Modifier... modifiers)  
      java.nio.file.Path relativize​(java.nio.file.Path other)  
      java.nio.file.Path resolve​(java.nio.file.Path other)  
      boolean startsWith​(java.nio.file.Path other)  
      java.nio.file.Path subpath​(int beginIndex, int endIndex)  
      java.nio.file.Path toAbsolutePath()  
      java.io.File toFile()
      This Path implementation does not allow the caller to break out to File abstractions.
      java.nio.file.Path toRealPath​(java.nio.file.LinkOption... options)  
      java.lang.String toString()  
      java.net.URI toUri()  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

      • Methods inherited from interface java.nio.file.Path

        endsWith, iterator, register, resolve, resolveSibling, resolveSibling, startsWith

    • Field Detail

      • path

        protected final java.lang.String[] path

    • Constructor Detail

      • MetaPath

        public MetaPath​(MetaFS metaFS,
                java.lang.String initial,
                java.lang.String... remaining)

      • MetaPath

        public MetaPath​(MetaFS metaFS,
                java.lang.String[] components,
                boolean absolute)

    • Method Detail

      • getFileSystem

        public MetaFS getFileSystem()
        Specified by:
        getFileSystem in interface java.nio.file.Path

      • isAbsolute

        public boolean isAbsolute()
        Specified by:
        isAbsolute in interface java.nio.file.Path

      • getRoot

        public java.nio.file.Path getRoot()
        Specified by:
        getRoot in interface java.nio.file.Path

      • getFileName

        public java.nio.file.Path getFileName()
        Specified by:
        getFileName in interface java.nio.file.Path

      • getParent

        public java.nio.file.Path getParent()
        Specified by:
        getParent in interface java.nio.file.Path

      • getNameCount

        public int getNameCount()
        Specified by:
        getNameCount in interface java.nio.file.Path

      • getName

        public java.nio.file.Path getName​(int index)
        Specified by:
        getName in interface java.nio.file.Path

      • subpath

        public java.nio.file.Path subpath​(int beginIndex,
                                  int endIndex)
        Specified by:
        subpath in interface java.nio.file.Path

      • startsWith

        public boolean startsWith​(java.nio.file.Path other)
        Specified by:
        startsWith in interface java.nio.file.Path

      • endsWith

        public boolean endsWith​(java.nio.file.Path other)
        Specified by:
        endsWith in interface java.nio.file.Path

      • normalize

        public java.nio.file.Path normalize()
        Specified by:
        normalize in interface java.nio.file.Path

      • resolve

        public java.nio.file.Path resolve​(java.nio.file.Path other)
        Specified by:
        resolve in interface java.nio.file.Path

      • relativize

        public java.nio.file.Path relativize​(java.nio.file.Path other)
        Specified by:
        relativize in interface java.nio.file.Path

      • toAbsolutePath

        public java.nio.file.Path toAbsolutePath()
        Specified by:
        toAbsolutePath in interface java.nio.file.Path

      • toRealPath

        public java.nio.file.Path toRealPath​(java.nio.file.LinkOption... options)
                              throws java.io.IOException
        Specified by:
        toRealPath in interface java.nio.file.Path
        Throws:
        java.io.IOException

      • register

        public java.nio.file.WatchKey register​(java.nio.file.WatchService watcher,
                                       java.nio.file.WatchEvent.Kind<?>[] events,
                                       java.nio.file.WatchEvent.Modifier... modifiers)
                                throws java.io.IOException
        Specified by:
        register in interface java.nio.file.Path
        Specified by:
        register in interface java.nio.file.Watchable
        Throws:
        java.io.IOException

      • compareTo

        public int compareTo​(java.nio.file.Path other)
        Specified by:
        compareTo in interface java.lang.Comparable<java.nio.file.Path>
        Specified by:
        compareTo in interface java.nio.file.Path

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.nio.file.Path
        Overrides:
        toString in class java.lang.Object

      • asRelativePath

        public MetaPath asRelativePath()

      • toUri

        public java.net.URI toUri()
        Specified by:
        toUri in interface java.nio.file.Path

      • toFile

        public java.io.File toFile()
        This Path implementation does not allow the caller to break out to File abstractions.
        Specified by:
        toFile in interface java.nio.file.Path
        Returns:
        null, signifying that there are no defined File semantics for a Path

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in interface java.nio.file.Path
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.nio.file.Path
        Overrides:
        hashCode in class java.lang.Object