JkAbstractPathTree

java.lang.Object
- dev.jeka.core.api.file.JkAbstractPathTree<T>

Type Parameters:

T - for self returning keeping the actual type.

Direct Known Subclasses:

JkPathTree, JkZipTree
```
public class JkAbstractPathTree<T extends JkAbstractPathTree>
extends java.lang.Object
```
Provides a view on files and sub-folders contained in a given directory or zip file. A JkPathTree may have some include/exclude filters to include only or exclude specified files.
When speaking about files contained in a JkAbstractPathTree, we mean all files contained in its root directory or subdirectories, matching positively the filter defined on it.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JkAbstractPathTree.FileChange`
`class`	`JkAbstractPathTree.JkPathTreeStream` A decorator class for Stream that provides additional functionality specific to path trees.

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.function.Supplier<java.nio.file.Path> rootSupplier

Fields
Modifier and Type	Field and Description
`protected java.util.function.Supplier<java.nio.file.Path>`	`rootSupplier`

Constructor Summary

Constructors
Modifier Constructor and Description

protected JkAbstractPathTree(java.util.function.Supplier<java.nio.file.Path> rootSupplier, JkPathMatcher matcher)

Constructors
Modifier	Constructor and Description
`protected`	`JkAbstractPathTree(java.util.function.Supplier<java.nio.file.Path> rootSupplier, JkPathMatcher matcher)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`T`	`andMatcher(java.nio.file.PathMatcher pathMatcher)` Creates a copy of this `JkAbstractPathTree` augmented with the specified `JkPathMatcher`
`T`	`andMatching(boolean positive, java.lang.Iterable<java.lang.String> globPatterns)` Creates a copy of this `JkAbstractPathTree` augmented with the specified pattern matcher.
`T`	`andMatching(boolean positive, java.lang.String... globPatterns)` Creates a copy of this `JkAbstractPathTree` augmented with the specified pattern matcher.
`T`	`andMatching(java.lang.String... globPatterns)` Shorthand to `andMatching(true, globPatterns...)`.
`java.lang.String`	`checksum(java.lang.String algorithm)` Computes the checksum of this tree content.
`boolean`	`containFiles()`
`void`	`copyFile(java.lang.String sourcePath, java.nio.file.Path destinationDir, java.nio.file.CopyOption... copyOptions)` Copies a single file contained in this `JkAbstractPathTree` to the specified directory.
`int`	`copyTo(java.nio.file.Path destinationDir, java.nio.file.CopyOption... copyOptions)` Copies files contained in this `JkAbstractPathTree` to the specified directory.
`int`	`count(int max, boolean includeDirectories)` Returns the file count contained in this `JkAbstractPathTree` to concurrence to specified max count.
`T`	`createIfNotExist()` Creates root directory if not exists.
`T`	`deleteContent()` Deletes each and every file in this tree except the root and files not matching this tree filter.
`T`	`deleteRoot()` Deletes the root directory of the path tree.
`T`	`deleteRootIfExist()` Deletes the root directory of the path tree.
`boolean`	`exists()` Returns `true` if the root directory exists.
`java.nio.file.Path`	`get(java.lang.String relativePath)` Returns path relative to this root of the specified relative path.
`java.util.List<java.nio.file.Path>`	`getFiles()` Returns list of paths returned by `stream(FileVisitOption...)` but excluding directories from the result.
`JkPathMatcher`	`getMatcher()` Returns the filter defined on this `JkAbstractPathTree`, never `null`.
`java.util.List<java.nio.file.Path>`	`getRelativeFiles()` Deprecated. Use `stream(FileVisitOption...)` in combination with `JkAbstractPathTree.JkPathTreeStream.relativizeFromRoot()` instead
`java.nio.file.Path`	`getRoot()` Returns the root directory.
`T`	`goTo(java.lang.String relativePath)` Creates a `JkAbstractPathTree` having the specified relative path to this root as getRoot directory.
`boolean`	`hasFilter()`
`T`	`importDir(java.nio.file.Path dirToCopy, java.nio.file.CopyOption... copyOptions)` Copies the specified directory and its content at the root of this tree.
`T`	`importFile(java.nio.file.Path src, java.lang.String targetName, java.nio.file.StandardCopyOption... copyOptions)` Copies the specified file at the specified path within this tree.
`T`	`importFiles(java.lang.Iterable<java.nio.file.Path> files, java.nio.file.StandardCopyOption... copyOptions)` Copies the specified files at the root of this tree.
`T`	`importTree(JkAbstractPathTree tree, java.nio.file.CopyOption... copyOptions)` Copies the content of the specified tree at the root of this one.
`protected T`	`newInstance(java.util.function.Supplier<java.nio.file.Path> pathSupplier, JkPathMatcher pathMatcher)`
`static JkAbstractPathTree`	`of(java.nio.file.Path rootDir)` Creates a `JkAbstractPathTree` having the specified root directory.
`static JkAbstractPathTree`	`of(java.lang.String rootDir)`
`T`	`resolvedTo(java.nio.file.Path newRoot)` Assuming the root folder is relative, this creates an identical `JkAbstractPathTree` but having the root as : [specified new root]/[former root]
`JkAbstractPathTree.JkPathTreeStream`	`stream(java.nio.file.FileVisitOption... options)` Returns a stream of paths in the directory tree rooted at the specified directory, filtered by the specified options.
`JkAbstractPathTree.JkPathTreeStream`	`streamBreathFirst()` Same as `stream(FileVisitOption...)` but using a breath-first traversal algorithm.
`java.lang.String`	`toString()`
`void`	`watch(long millis, java.util.concurrent.atomic.AtomicBoolean run, java.util.function.Consumer<java.util.List<JkAbstractPathTree.FileChange>> fileChangeConsumer)` Watches file and directory changes involved in this path tree.
`void`	`watch(long millis, java.util.concurrent.atomic.AtomicBoolean run, java.lang.Runnable runnable)` Same as `watch(long, AtomicBoolean, Consumer)` but just triggering a consumer on file changes.
`void`	`watch(long millis, java.lang.Runnable runnable)` Same as `watch(long, AtomicBoolean, Runnable)` but running indefinitely.
`T`	`withMatcher(JkPathMatcher pathMatcher)` Creates a `JkAbstractPathTree` which is a copy of this `JkAbstractPathTree` but the matcher is replaced with the specified one.
`protected T`	`withRoot(java.nio.file.Path newRoot)`
`T`	`zipTo(java.nio.file.Path destination)` Zips the content of this tree to the specified destination file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - rootSupplier
```
protected final java.util.function.Supplier<java.nio.file.Path> rootSupplier
```
- Constructor Detail
  - JkAbstractPathTree
```
protected JkAbstractPathTree(java.util.function.Supplier<java.nio.file.Path> rootSupplier,
                             JkPathMatcher matcher)
```
- Method Detail
  - of
```
public static JkAbstractPathTree of(java.nio.file.Path rootDir)
```
    Creates a JkAbstractPathTree having the specified root directory.
  - of
```
public static JkAbstractPathTree of(java.lang.String rootDir)
```
    See Also:
    
    of(Path)
  - newInstance
```
protected T newInstance(java.util.function.Supplier<java.nio.file.Path> pathSupplier,
                        JkPathMatcher pathMatcher)
```
  - withRoot
```
protected T withRoot(java.nio.file.Path newRoot)
```
  - getRoot
```
public java.nio.file.Path getRoot()
```
    Returns the root directory. In case of zip archive it returns a directory entry within the zip archive.
  - getMatcher
```
public JkPathMatcher getMatcher()
```
    Returns the filter defined on this JkAbstractPathTree, never null.
  - hasFilter
```
public boolean hasFilter()
```
  - exists
```
public boolean exists()
```
    Returns true if the root directory exists.
  - createIfNotExist
```
public T createIfNotExist()
```
    Creates root directory if not exists.
  - stream
```
public JkAbstractPathTree.JkPathTreeStream stream(java.nio.file.FileVisitOption... options)
```
    Returns a stream of paths in the directory tree rooted at the specified directory, filtered by the specified options. The result contains folders, including root.
    The tree is traversed using a deep first algorithm.
    The returned paths are NOT relatives to the root of this tree.
    The returned stream provides means o filer file only, and transform to paths relative to root dir.
  - streamBreathFirst
```
public JkAbstractPathTree.JkPathTreeStream streamBreathFirst()
```
    Same as stream(FileVisitOption...) but using a breath-first traversal algorithm.
  - getRelativeFiles
```
@Deprecated
public java.util.List<java.nio.file.Path> getRelativeFiles()
```
    Deprecated. Use stream(FileVisitOption...) in combination with JkAbstractPathTree.JkPathTreeStream.relativizeFromRoot() instead
    
    Same as getFiles() but returning paths relative to this tree root.
  - getFiles
```
public java.util.List<java.nio.file.Path> getFiles()
```
    Returns list of paths returned by stream(FileVisitOption...) but excluding directories from the result.
  - goTo
```
public T goTo(java.lang.String relativePath)
```
    Creates a JkAbstractPathTree having the specified relative path to this root as getRoot directory. Note that the returned tree has no filter even if this tree has one.
  - resolvedTo
```
public T resolvedTo(java.nio.file.Path newRoot)
```
    Assuming the root folder is relative, this creates an identical JkAbstractPathTree but having the root as : [specified new root]/[former root]
  - get
```
public java.nio.file.Path get(java.lang.String relativePath)
```
    Returns path relative to this root of the specified relative path.
  - importDir
```
public T importDir(java.nio.file.Path dirToCopy,
                   java.nio.file.CopyOption... copyOptions)
```
    Copies the specified directory and its content at the root of this tree.
  - importTree
```
public T importTree(JkAbstractPathTree tree,
                    java.nio.file.CopyOption... copyOptions)
```
    Copies the content of the specified tree at the root of this one. Specified dir to copy to might not exist. The structure of the specified tree is preserved. Note that the root of the specified tree is not part of the copied content.
  - importFiles
```
public T importFiles(java.lang.Iterable<java.nio.file.Path> files,
                     java.nio.file.StandardCopyOption... copyOptions)
```
    Copies the specified files at the root of this tree. The copy is not recursive.
  - importFile
```
public T importFile(java.nio.file.Path src,
                    java.lang.String targetName,
                    java.nio.file.StandardCopyOption... copyOptions)
```
    Copies the specified file at the specified path within this tree.
  - deleteContent
```
public T deleteContent()
```
    Deletes each and every file in this tree except the root and files not matching this tree filter.
  - deleteRoot
```
public T deleteRoot()
```
    Deletes the root directory of the path tree. This method also deletes all the content inside the root directory.
  - deleteRootIfExist
```
public T deleteRootIfExist()
```
    Deletes the root directory of the path tree. This method also deletes all the content inside the root directory.
  - zipTo
```
public T zipTo(java.nio.file.Path destination)
```
    Zips the content of this tree to the specified destination file. If the specified destination file already exists, the content of this tree is appended to the existing archive, overriding existing entries within the archive.
  - copyTo
```
public int copyTo(java.nio.file.Path destinationDir,
                  java.nio.file.CopyOption... copyOptions)
```
    Copies files contained in this JkAbstractPathTree to the specified directory.
  - copyFile
```
public void copyFile(java.lang.String sourcePath,
                     java.nio.file.Path destinationDir,
                     java.nio.file.CopyOption... copyOptions)
```
    Copies a single file contained in this JkAbstractPathTree to the specified directory. File name remains the same.
    
    Parameters:
    
    sourcePath - The relative path of the source file from this tree root.
  - andMatcher
```
public T andMatcher(java.nio.file.PathMatcher pathMatcher)
```
    Creates a copy of this JkAbstractPathTree augmented with the specified JkPathMatcher
  - withMatcher
```
public T withMatcher(JkPathMatcher pathMatcher)
```
    Creates a JkAbstractPathTree which is a copy of this JkAbstractPathTree but the matcher is replaced with the specified one.
  - andMatching
```
public T andMatching(boolean positive,
                     java.lang.String... globPatterns)
```
    Creates a copy of this JkAbstractPathTree augmented with the specified pattern matcher.
  - andMatching
```
public T andMatching(java.lang.String... globPatterns)
```
    Shorthand to andMatching(true, globPatterns...).
  - andMatching
```
public T andMatching(boolean positive,
                     java.lang.Iterable<java.lang.String> globPatterns)
```
    Creates a copy of this JkAbstractPathTree augmented with the specified pattern matcher.
  - count
```
public int count(int max,
                 boolean includeDirectories)
```
    Returns the file count contained in this JkAbstractPathTree to concurrence to specified max count. If the effective count is greater than max count, this method returns max count + 1. This method is designed to stop file traversal as soon as count is greater than max.
  - containFiles
```
public boolean containFiles()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - watch
```
public void watch(long millis,
                  java.util.concurrent.atomic.AtomicBoolean run,
                  java.util.function.Consumer<java.util.List<JkAbstractPathTree.FileChange>> fileChangeConsumer)
```
    Watches file and directory changes involved in this path tree. This method blocks for the specified millis time to capture filesystem changes and pass them to the specified consumer.
    
    Parameters:
    
    millis - Time to wait for capturing file changes
    
    run - Semaphore, this methods loop until this values false
    
    fileChangeConsumer - The consumer to be invoked on file changes
  - watch
```
public void watch(long millis,
                  java.util.concurrent.atomic.AtomicBoolean run,
                  java.lang.Runnable runnable)
```
    Same as watch(long, AtomicBoolean, Consumer) but just triggering a consumer on file changes.
  - watch
```
public void watch(long millis,
                  java.lang.Runnable runnable)
```
    Same as watch(long, AtomicBoolean, Runnable) but running indefinitely.
  - checksum
```
public java.lang.String checksum(java.lang.String algorithm)
```
    Computes the checksum of this tree content. This includes file contents and file structure. This means that changing a file name without but keeping its content unchanged will produce distinct checksum.
    
    Parameters:
    
    algorithm - algorithm used to produce checksum, such as md5 or sha256.

Class JkAbstractPathTree<T extends JkAbstractPathTree>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rootSupplier

Constructor Detail

JkAbstractPathTree

Method Detail

of

of

newInstance

withRoot

getRoot

getMatcher

hasFilter

exists

createIfNotExist

stream

streamBreathFirst

getRelativeFiles

getFiles

goTo

resolvedTo

get

importDir

importTree

importFiles

importFile

deleteContent

deleteRoot

deleteRootIfExist

zipTo

copyTo

copyFile

andMatcher

withMatcher

andMatching

andMatching

andMatching

count

containFiles

toString

watch

watch

watch

checksum