Interface DocumentationDirectory

All Superinterfaces:

FileTree<FileResource>, InputTree<FileResource>, Resource, Resources<FileResource>

All Known Subinterfaces:

JavadocDirectory

public interface DocumentationDirectory
extends FileTree<FileResource>

A FileTree that represents a directory with documentation generated by some provider.

Nested Class Summary

Nested classes/interfaces inherited from interface InputTree

InputTree.Entry<T>

Method Summary

Static Methods

Modifier and Type	Method	Description
static DocumentationDirectory	of(Project project, Path path, String... patterns)	Creates a new documentation directory resource from the given project and path.

Methods inherited from interface FileTree

cleanup, clear, paths, root, root, withDirectories

Methods inherited from interface InputTree

entries, exclude

Methods inherited from interface Resource

asOfLocalized, isNewerThan, name, type

Methods inherited from interface Resources

add, addAll, addAll, asOf, get, isEmpty, stream

Method Details

of

static DocumentationDirectory of(Project project,
 Path path,
 String... patterns)

Creates a new documentation directory resource from the given project and path.

Parameters:

project - the project

path - the path relative to the project's directory (or an absolute path)

patterns - the patterns. If no patterns are given, the default pattern "**/*" is used

Returns:

the file resource