Package io.quarkus.paths

Class ArchivePathTree

java.lang.Object
io.quarkus.paths.PathTreeWithManifest
io.quarkus.paths.ArchivePathTree
All Implemented Interfaces:
PathTree
public class ArchivePathTree extends PathTreeWithManifest implements PathTree

  • Field Details

    • archive

      protected final Path archive

  • Method Details

    • isArchiveOrigin

      public boolean isArchiveOrigin()
      Description copied from interface: PathTree
      Whether the content of this tree comes from an archive or not.

      This is useful for instance when you want to determine if the resources can be updated in dev mode.

      Specified by:
      isArchiveOrigin in interface PathTree

    • getRoots

      public Collection<Path> getRoots()
      Description copied from interface: PathTree
      The roots of the path tree.

      Note that you shouldn't use these roots for browsing except if the PathTree is open.

      Specified by:
      getRoots in interface PathTree
      Returns:
      roots of the path tree

    • walk

      public void walk(PathVisitor visitor)
      Description copied from interface: PathTree
      Walks the tree.

      This method will make sure the relevant multi release content is associated with the expected resource name paths for the current Java version.

      Specified by:
      walk in interface PathTree
      Parameters:
      visitor - path visitor

    • walkRaw

      public void walkRaw(PathVisitor visitor)
      Description copied from interface: PathTree
      Walks the tree without remapping multi release content to the paths expected for the current Java version.
      Specified by:
      walkRaw in interface PathTree
      Parameters:
      visitor - path visitor

    • walkIfContains

      public void walkIfContains(String resourceDirName, PathVisitor visitor)
      Description copied from interface: PathTree
      Walks a subtree of resources in this tree that begins with a passed in resourceDirName. If this tree does not contain resource resourceDirName then the method returns without an error.

      This method does not create a new PathTree with the root at resourceDirName. It simply applies an inclusion filter to this PathTree instance, keeping the same root.

      Specified by:
      walkIfContains in interface PathTree
      Parameters:
      resourceDirName - directory resource name starting from which the walk should begin
      visitor - path visitor

    • getResourceNames

      public Set<String> getResourceNames()
      Description copied from interface: PathTree
      Returns a set of resource names provided by this path tree. The set may include both directories and files.
      Specified by:
      getResourceNames in interface PathTree
      Returns:
      a set of resource names provided by this path tree

    • apply

      protected <T> T apply(String resourceName, Function<PathVisit,T> func, boolean manifestEnabled)
      Specified by:
      apply in class PathTreeWithManifest

    • accept

      public void accept(String resourceName, Consumer<PathVisit> consumer)
      Description copied from interface: PathTree
      Consumes a given resource from the tree. If the resource isn't found in the tree, the PathVisit argument passed to the consumer will be null.
      Specified by:
      accept in interface PathTree
      Parameters:
      resourceName - resource to consume
      consumer - path consumer

    • contains

      public boolean contains(String resourceName)
      Description copied from interface: PathTree
      Checks whether the tree contains a resource.
      Specified by:
      contains in interface PathTree
      Parameters:
      resourceName - resource name to check
      Returns:
      true, in case the tree contains the path, otherwise - false

    • openFs

      protected io.quarkus.fs.util.rozip.ReadOnlyZipFileSystem openFs() throws IOException
      Throws:
      IOException

    • open

      public OpenPathTree open()
      Description copied from interface: PathTree
      Returns an OpenPathTree for this tree, which is supposed to be closed at the end of processing. It is meant to be an optimization when processing multiple paths of path trees that represent archives. If a path tree does not represent an archive but a directory, for example, this method is expected to be a no-op, returning the original tree as an instance of OpenPathTree.
      Specified by:
      open in interface PathTree
      Returns:
      an instance of OpenPathTree for this path tree

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object