Index
All Classes and Interfaces|All Packages
A
- append(DepthSymbol) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- areCompactDirectoriesUsed() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- areCompactDirectoriesUsed() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions
-
Are directories compacted into one entry?
- areEmojisUsed() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- areEmojisUsed() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions
-
Are emojis used (filename, etc.)?
B
- build() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinterBuilder
- builder() - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter
-
Customize creation of a pretty printer through a builder.
C
- CLASSIC_ASCII - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions.TreeFormat
-
Uses characters: |--, `-- and │
- create(RenderingOptions) - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.TreeEntryRenderer
-
Create a new tree renderer, using given options
- create(ScanningOptions) - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.PathToTreeScanner
-
Creates a new path handler with given options.
- createDefault() - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter
-
Create a pretty printer with default options.
- createDefault() - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Create new default options that can be customized using various
withXXXmethods. - createDefault() - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.EmojiMapping
- createDefault() - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- createNewEmpty() - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- customizeOptions(UnaryOperator<PrettyPrintOptions>) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinterBuilder
D
- Depth - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth
- Depth(List<DepthSymbol>) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- DepthFormatter - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth
- DepthSymbol - Enum Class in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth
- DirectoryEntry(Path, List<TreeEntry>) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryEntry
- DirectoryListingExceptionEntry(Path, IOException) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryListingExceptionEntry
- DirectoryReadingAttributesExceptionEntry(Path, IOException) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryReadingAttributesExceptionEntry
E
- EmojiMapping - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file
- equals(Object) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
F
- fileComparator() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- fileComparator() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.ScanningOptions
- FileEntry(Path, BasicFileAttributes) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileEntry
- FileFormatter - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file
- FileReadingAttributesExceptionEntry(Path, IOException) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileReadingAttributesExceptionEntry
- FileTreePrettyPrinter - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter
-
Pretty prints a file tree, and returns the result as a String.
- FileTreePrettyPrinterBuilder - Class in io.github.computerdaddyguy.jfiletreeprettyprinter
- FileTreePrettyPrinterBuilder() - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinterBuilder
- format(Depth) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthFormatter
- formatChildLimitReached(TreeEntry.SkippedChildrenEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- formatDirectoryBegin(TreeEntry.DirectoryEntry, List<Path>) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- formatDirectoryException(TreeEntry.DirectoryExceptionTreeEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- formatFile(TreeEntry.FileEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- formatFileException(TreeEntry.FileReadingAttributesExceptionEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- formatMaxDepthReached(TreeEntry.MaxDepthReachEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
G
- getAttrs() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileEntry
- getChildrenLimitFunction() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- getChildrenLimitFunction() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.ScanningOptions
- getDepth() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.MaxDepthReachEntry
- getDir() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryEntry
- getDir() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryListingExceptionEntry
- getDir() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryReadingAttributesExceptionEntry
- getDir() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry
- getEntries() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryEntry
- getErrorEmoji(Path, IOException) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.EmojiMapping
-
Get the emoji to display for the given file, in case of error.
- getException() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryListingExceptionEntry
- getException() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryReadingAttributesExceptionEntry
- getException() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry
- getException() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileReadingAttributesExceptionEntry
- getFile() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileEntry
- getFile() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileReadingAttributesExceptionEntry
- getFileEmoji(Path) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.EmojiMapping
-
Get the emoji to display for the given file (i.e. the file type icon).
- getInstance(RenderingOptions.TreeFormat) - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthFormatter
- getMaxDepth() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- getMaxDepth() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.ScanningOptions
- getSize() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- getSkippedChildren() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.SkippedChildrenEntry
- getSymbols() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- getTreeFormat() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
- getTreeFormat() - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions
-
The format used to render file structure tree.
H
- hasExtension(String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
-
Create a predicate to test if the file name ends with ".
". - hasExtension(Path, String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
-
Test if the file name ends with ".
". - hashCode() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- hasName(String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasName(Path, String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameEndingWith(String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameEndingWith(Path, String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameIgnoreCase(String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameIgnoreCase(Path, String) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameMatching(Path, Pattern) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
- hasNameMatching(Pattern) - Static method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates
I
- io.github.computerdaddyguy.jfiletreeprettyprinter - package io.github.computerdaddyguy.jfiletreeprettyprinter
- io.github.computerdaddyguy.jfiletreeprettyprinter.renderer - package io.github.computerdaddyguy.jfiletreeprettyprinter.renderer
- io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth - package io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth
- io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file - package io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file
- io.github.computerdaddyguy.jfiletreeprettyprinter.scanner - package io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- isEmpty() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
L
- LAST_FILE - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Symbol for a file that is the last in its directory (=has no next file).
M
- MaxDepthReachEntry(int) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.MaxDepthReachEntry
N
- NON_LAST_FILE - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Symbol for a file that is not the last in its directory (=has a next file).
- NONE - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Symbol of representing the absence of file.
P
- PathPredicates - Class in io.github.computerdaddyguy.jfiletreeprettyprinter
- PathToTreeScanner - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- pop() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- prettyPrint(String) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter
-
Pretty prints the given path.
- prettyPrint(Path) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter
-
Pretty prints the given path.
- PrettyPrintOptions - Class in io.github.computerdaddyguy.jfiletreeprettyprinter
- PrettyPrintOptions() - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
R
- RenderingOptions - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer
- RenderingOptions.TreeFormat - Enum Class in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer
- renderTree(TreeEntry) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.TreeEntryRenderer
S
- scan(Path) - Method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.PathToTreeScanner
- ScanningOptions - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- SKIP - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Symbol for representing a "skip", meaning a continue until next file.
- SkippedChildrenEntry(List<Path>) - Constructor for class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.SkippedChildrenEntry
T
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.Depth
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryListingExceptionEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.DirectoryExceptionTreeEntry.DirectoryReadingAttributesExceptionEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.FileReadingAttributesExceptionEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.MaxDepthReachEntry
- toString() - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.TreeEntry.SkippedChildrenEntry
- TreeEntry - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.DirectoryEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.DirectoryExceptionTreeEntry - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.DirectoryExceptionTreeEntry.DirectoryListingExceptionEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.DirectoryExceptionTreeEntry.DirectoryReadingAttributesExceptionEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.FileEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.FileReadingAttributesExceptionEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.MaxDepthReachEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntry.SkippedChildrenEntry - Class in io.github.computerdaddyguy.jfiletreeprettyprinter.scanner
- TreeEntryRenderer - Interface in io.github.computerdaddyguy.jfiletreeprettyprinter.renderer
U
- UNICODE_BOX_DRAWING - Enum constant in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions.TreeFormat
-
Uses characters: ├─, └─ and │
V
- valueOf(String) - Static method in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions.TreeFormat
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.depth.DepthSymbol
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.RenderingOptions.TreeFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withChildrenLimit(int) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Set a fixed limit to the number of visited children, per directory.
- withChildrenLimitFunction(ToIntFunction<Path>) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Set a function that dynamically limits the number of visited children, depending on the parent directory.
- withCompactDirectories(boolean) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Whether or not compact directories chain into a single entry in the rendered tree.
- withEmojis(boolean) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Whether or not use emojis in directory/filename rendering.
- withMaxDepth(int) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Set the max directory depth from the root.
- withOptions(PrettyPrintOptions) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinterBuilder
- withTreeFormat(RenderingOptions.TreeFormat) - Method in class io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions
-
Sets the depth rendering format.
- wrapWithEmojis(FileFormatter) - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
- wrapWithEmojis(FileFormatter, EmojiMapping) - Static method in interface io.github.computerdaddyguy.jfiletreeprettyprinter.renderer.file.FileFormatter
All Classes and Interfaces|All Packages