Package io.quarkus.paths

Class CachingPathTree

java.lang.Object

io.quarkus.paths.CachingPathTree

All Implemented Interfaces:

OpenPathTree, PathTree, Closeable, AutoCloseable

public class CachingPathTree
extends Object
implements OpenPathTree

Method Summary

Modifier and Type	Method	Description
void	accept(String relativePath, Consumer<PathVisit> func)	Consumes a given path relative to the root of the tree.
<T> T	apply(String relativePath, Function<PathVisit,T> func)	Applies a function to a given path relative to the root of the tree.
void	close()
boolean	contains(String relativePath)	Checks whether the tree contains a relative path.
boolean	equals(Object obj)
Manifest	getManifest()	If META-INF/MANIFEST.MF found, reads it and returns an instance of Manifest, otherwise returns null.
PathTree	getOriginalTree()
Path	getPath(String relativePath)
Collection<Path>	getRoots()	The roots of the path tree.
int	hashCode()
boolean	isOpen()
static CachingPathTree	of(PathTree pathTree)
OpenPathTree	open()	Returns an OpenPathTree for this tree, which is supposed to be closed at the end of processing.
void	walk(PathVisitor visitor)	Walks the tree.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.paths.PathTree

isEmpty

Method Detail

of

public static CachingPathTree of(PathTree pathTree)

getRoots

public Collection<Path> getRoots()

Description copied from interface: PathTree

The roots of the path tree.

Specified by:

getRoots in interface PathTree

Returns:

roots of the path tree

getManifest

public Manifest getManifest()

Description copied from interface: PathTree

If META-INF/MANIFEST.MF found, reads it and returns an instance of Manifest, otherwise returns null.

Specified by:

getManifest in interface PathTree

Returns:

parsed META-INF/MANIFEST.MF if it's found, otherwise null

walk

public void walk(PathVisitor visitor)

Description copied from interface: PathTree

Walks the tree.

Specified by:

walk in interface PathTree

Parameters:

visitor - path visitor

apply

public <T> T apply(String relativePath,
                   Function<PathVisit,T> func)

Description copied from interface: PathTree

Applies a function to a given path relative to the root of the tree. If the path isn't found in the tree, the PathVisit argument passed to the function will be null.

Specified by:

apply in interface PathTree

Type Parameters:

T - resulting type

Parameters:

relativePath - relative path to process

func - processing function

Returns:

result of the function

accept

public void accept(String relativePath,
                   Consumer<PathVisit> func)

Description copied from interface: PathTree

Consumes a given path relative to the root of the tree. If the path isn't found in the tree, the PathVisit argument passed to the consumer will be null.

Specified by:

accept in interface PathTree

Parameters:

relativePath - relative path to consume

func - path consumer

contains

public boolean contains(String relativePath)

Description copied from interface: PathTree

Checks whether the tree contains a relative path.

Specified by:

contains in interface PathTree

Parameters:

relativePath - path relative to the root of the tree

Returns:

true, in case the tree contains the path, otherwise - false

getPath

public Path getPath(String relativePath)

Specified by:

getPath in interface OpenPathTree

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

isOpen

public boolean isOpen()

Specified by:

isOpen in interface OpenPathTree

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getOriginalTree

public PathTree getOriginalTree()

Specified by:

getOriginalTree in interface OpenPathTree

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object