Module org.jooq

Package org.jooq

Class FilePattern

java.lang.Object

org.jooq.FilePattern

@Internal
public final class FilePattern
extends Object

A utility class that can traverse a directory structure given some ant-style file patterns, or classpath resources.

The following algorithm is applied when traversing sources:

• If pattern is a valid classpath resource, load the single Source from there
• If pattern is a valid file on the file system, load the single Source from there
• Match all files on the file system according to pattern (interpreted as an ant-style file pattern), and load all of the Source items given sort(). An example pattern is src/main/resources/**/*.sql

This is INTERNAL API. Please do not use directly as API may change incompatibly.

Author:

Lukas Eder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FilePattern.Sort	The sort algorithm to be applied to directory contents.

Constructor Summary

Constructors

Constructor	Description
FilePattern()

Method Summary

Modifier and Type	Method	Description
final File	basedir()
final FilePattern	basedir(File newBasedir)
final List<Source>	collect()	Retrieve a set of Source items from this pattern.
final String	encoding()
final FilePattern	encoding(String newEncoding)
final Comparator<File>	fileComparator()
static final Comparator<File>	fileComparator(FilePattern.Sort sort)
final void	load(Consumer<Source> loader)	Load a set of Source items from this pattern.
final boolean	matches(String path)	Whether a given path matches the pattern.
final String	path(File file)	Get the path of a File relative to this pattern's basedir(), or null if the file doesn't match this pattern, or isn't in basedir().
final File	pathFile(File file)	Get the path of a File relative to this pattern's basedir(), or null if the file doesn't match this pattern, or isn't in basedir().
final String	pattern()
final FilePattern	pattern(String newPattern)
final FilePattern.Sort	sort()
final FilePattern	sort(FilePattern.Sort newSort)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FilePattern

public FilePattern()

Method Details

sort

public final FilePattern.Sort sort()

sort

public final FilePattern sort(FilePattern.Sort newSort)

basedir

public final File basedir()

basedir

public final FilePattern basedir(File newBasedir)

pattern

public final String pattern()

pattern

public final FilePattern pattern(String newPattern)

encoding

public final String encoding()

encoding

public final FilePattern encoding(String newEncoding)

fileComparator

public final Comparator<File> fileComparator()

fileComparator

public static final Comparator<File> fileComparator(FilePattern.Sort sort)

matches

public final boolean matches(String path)

Whether a given path matches the pattern.

path

public final String path(File file)

Get the path of a File relative to this pattern's basedir(), or null if the file doesn't match this pattern, or isn't in basedir().

pathFile

public final File pathFile(File file)

Get the path of a File relative to this pattern's basedir(), or null if the file doesn't match this pattern, or isn't in basedir().

collect

public final List<Source> collect()

Retrieve a set of Source items from this pattern.

Throws:

IOException - if something goes wrong while loading file contents.

load

public final void load(Consumer<Source> loader)

Load a set of Source items from this pattern.

Throws:

IOException - if something goes wrong while loading file contents.

toString

public String toString()

Overrides:

toString in class Object