Class DefaultFileTree<T extends FileResource>

java.lang.Object

org.jdrupes.builder.core.ResourceObject

org.jdrupes.builder.core.DefaultResources<T>

org.jdrupes.builder.core.DefaultFileTree<T>

Type Parameters:

T - the type of the FileResources in the tree.

All Implemented Interfaces:

FileTree<T>, Proxyable, Resource, Resources<T>

Direct Known Subclasses:

DefaultClassTree, DefaultJavaResourceTree

public class DefaultFileTree<T extends FileResource>
extends DefaultResources<T>
implements FileTree<T>

The default implementation of a FileTree.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultFileTree(ResourceType<?> type, Project project, Path root, String pattern)	Returns a new file tree.

Method Summary

Modifier and Type	Method	Description
Instant	asOf()	The instant at which this resource was created or last modified.
FileTree<T>	clear()	Clears the contained resources.
FileTree<T>	delete()	Deletes all files in this file tree and directories that are empty after deletion of the files (expect for root, which is not deleted).
Stream<Path>	entries()	Returns the paths of the files in this file tree relative to its root.
boolean	equals(Object obj)
FileTree<T>	exclude(String pattern)	Add a file name pattern to exclude from the tree.
int	hashCode()
Path	root()	Returns the root of the file tree searched for files as an absolute path.
Path	root(boolean relativize)	Returns the root of the file tree containing the files.
Stream<T>	stream()	Retrieves the resources as a stream.
String	toString()
FileTree<T>	withDirectories()	Includes directories in the file tree if they match the pattern used when creating the file tree, and are not excluded (i.e. don't match the exclude pattern).

Methods inherited from class DefaultResources

add, isEmpty

Methods inherited from class ResourceObject

isLocked, name, name, type

Methods inherited from class Object

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

Methods inherited from interface Proxyable

backing

Methods inherited from interface Resource

asOfLocalized, name, type

Methods inherited from interface Resources

add, addAll, addAll, isEmpty

Constructor Details

DefaultFileTree

protected DefaultFileTree(ResourceType<?> type,
 Project project,
 Path root,
 String pattern)

Returns a new file tree. The file tree includes all files matching pattern in the tree starting at root. root may be specified as absolute path or as path relative to the project's directory (see Project.directory()).

if project is null, and root is a relative path, root is resolved against the current working directory. pattern

Parameters:

type - the resource type

project - the project

root - the root

pattern - the pattern

Method Details

withDirectories

public FileTree<T> withDirectories()

Description copied from interface: FileTree

Includes directories in the file tree if they match the pattern used when creating the file tree, and are not excluded (i.e. don't match the exclude pattern).

Specified by:

withDirectories in interface FileTree<T extends FileResource>

Returns:

the file tree

exclude

public FileTree<T> exclude(String pattern)

Description copied from interface: FileTree

Add a file name pattern to exclude from the tree.

Specified by:

exclude in interface FileTree<T extends FileResource>

Parameters:

pattern - the pattern

Returns:

the file tree

root

public Path root(boolean relativize)

Description copied from interface: FileTree

Returns the root of the file tree containing the files.

Specified by:

root in interface FileTree<T extends FileResource>

Parameters:

relativize - whether to return a path relative to the project's directory

Returns:

the path

root

public Path root()

Description copied from interface: FileTree

Returns the root of the file tree searched for files as an absolute path.

Specified by:

root in interface FileTree<T extends FileResource>

Returns:

the path

asOf

public Instant asOf()

Description copied from interface: Resource

The instant at which this resource was created or last modified.

Specified by:

asOf in interface Resource

Specified by:

asOf in interface Resources<T extends FileResource>

Returns:

the instant

stream

public Stream<T> stream()

Description copied from interface: Resources

Retrieves the resources as a stream.

Specified by:

stream in interface Resources<T extends FileResource>

Overrides:

stream in class DefaultResources<T extends FileResource>

Returns:

the stream

clear

public FileTree<T> clear()

Description copied from interface: Resources

Clears the contained resources.

Specified by:

clear in interface FileTree<T extends FileResource>

Specified by:

clear in interface Resources<T extends FileResource>

Overrides:

clear in class DefaultResources<T extends FileResource>

Returns:

the resources

delete

public FileTree<T> delete()

Description copied from interface: FileTree

Deletes all files in this file tree and directories that are empty after deletion of the files (expect for root, which is not deleted).

Specified by:

delete in interface FileTree<T extends FileResource>

Returns:

the file tree

entries

public Stream<Path> entries()

Description copied from interface: FileTree

Returns the paths of the files in this file tree relative to its root.

Specified by:

entries in interface FileTree<T extends FileResource>

Returns:

the stream

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultResources<T extends FileResource>

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultResources<T extends FileResource>

toString

public String toString()

Overrides:

toString in class DefaultResources<T extends FileResource>