com.google.cloud.tools.jib.filesystem

Class DirectoryWalker

java.lang.Object

com.google.cloud.tools.jib.filesystem.DirectoryWalker

public class DirectoryWalker
extends java.lang.Object

Recursively applies a function to each file in a directory.

Constructor Summary

Constructors

Constructor and Description
DirectoryWalker(java.nio.file.Path rootDir) Initialize with a root directory to walk.

Method Summary

Modifier and Type	Method and Description
DirectoryWalker	filter(java.util.function.Predicate<java.nio.file.Path> pathFilter) Adds a filter to the walked paths.
DirectoryWalker	filterRoot() Filters away the rootDir.
com.google.common.collect.ImmutableList<java.nio.file.Path>	walk() Walks rootDir.
com.google.common.collect.ImmutableList<java.nio.file.Path>	walk(PathConsumer pathConsumer) Walks rootDir and applies pathConsumer to each file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryWalker

public DirectoryWalker(java.nio.file.Path rootDir)
                throws java.nio.file.NotDirectoryException

Initialize with a root directory to walk.

Parameters:

rootDir - the root directory.

Throws:

java.nio.file.NotDirectoryException - if the root directory is not a directory.

Method Detail

filter

public DirectoryWalker filter(java.util.function.Predicate<java.nio.file.Path> pathFilter)

Adds a filter to the walked paths.

Parameters:

pathFilter - the filter. pathFilter returns true if the path should be accepted and false otherwise.

Returns:

this

filterRoot

public DirectoryWalker filterRoot()

Filters away the rootDir.

Returns:

this

walk

public com.google.common.collect.ImmutableList<java.nio.file.Path> walk(PathConsumer pathConsumer)
                                                                 throws java.io.IOException

Walks rootDir and applies pathConsumer to each file. Note that rootDir itself is visited as well.

Parameters:

pathConsumer - the consumer that is applied to each file.

Returns:

a list of Paths that were walked.

Throws:

java.io.IOException - if the walk fails.

walk

public com.google.common.collect.ImmutableList<java.nio.file.Path> walk()
                                                                 throws java.io.IOException

Walks rootDir.

Returns:

the walked files.

Throws:

java.io.IOException - if walking the files fails.