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.

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private final File	basedir
private final Comparator<File>	comparator
private final String	encoding
private static final JooqLogger	log
private final String	pattern
private final Pattern	regexForLoad
private final Pattern	regexForMatches
private final FilePattern.Sort	sort

Constructor Summary

Access	Constructor and Description
public	FilePattern()
private	FilePattern(FilePattern.Sort sort, File basedir, String pattern, String encoding)

Method Summary

Modifier and Type	Method and Description
public final File	basedir()
public final FilePattern	basedir(File newBasedir)
public final List<Source>	collect() Retrieve a set of `Source` items from this pattern.
public final String	encoding()
public final FilePattern	encoding(String newEncoding)
private static final Comparator<File>	fileComparator(FilePattern.Sort sort)
public final void	load(Consumer<Source> loader) Load a set of `Source` items from this pattern.
private final void	load(File file, Comparator<File> fileComparator, Pattern regex, Consumer<Source> loader)
private final void	load0(File file, Consumer<Source> loader)
public final boolean	matches(String path) Whether a given path matches the pattern.
public final String	pattern()
public final FilePattern	pattern(String newPattern)
private String	regex()
public final FilePattern.Sort	sort()
public final FilePattern	sort(FilePattern.Sort newSort)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

basedir	back to summary
private final File basedir

comparator	back to summary
private final Comparator<File> comparator

encoding	back to summary
private final String encoding

log	back to summary
private static final JooqLogger log

pattern	back to summary
private final String pattern

regexForLoad	back to summary
private final Pattern regexForLoad

regexForMatches	back to summary
private final Pattern regexForMatches

sort	back to summary
private final FilePattern.Sort sort

Constructor Detail

FilePattern	back to summary
public FilePattern()

FilePattern	back to summary
private FilePattern(FilePattern.Sort sort, File basedir, String pattern, String encoding)

Method Detail

basedir	back to summary
public final File basedir()

basedir	back to summary
public final FilePattern basedir(File newBasedir)

collect back to summary

collect	back to summary
public final List<Source> collect() Retrieve a set of `Source` items from this pattern. Exceptions IOException: if something goes wrong while loading file contents.

public final List<Source> collect()

Retrieve a set of Source items from this pattern.

Exceptions

IOException:: if something goes wrong while loading file contents.

encoding	back to summary
public final String encoding()

encoding	back to summary
public final FilePattern encoding(String newEncoding)

fileComparator	back to summary
private static final Comparator<File> fileComparator(FilePattern.Sort sort)

load back to summary

load	back to summary
public final void load(Consumer<Source> loader) Load a set of `Source` items from this pattern. Exceptions IOException: if something goes wrong while loading file contents.

public final void load(Consumer<Source> loader)

Load a set of Source items from this pattern.

Exceptions

IOException:: if something goes wrong while loading file contents.

load	back to summary
private final void load(File file, Comparator<File> fileComparator, Pattern regex, Consumer<Source> loader) throws IOException

load0	back to summary
private final void load0(File file, Consumer<Source> loader)

matches	back to summary
public final boolean matches(String path) Whether a given path matches the pattern.

pattern	back to summary
public final String pattern()

pattern	back to summary
public final FilePattern pattern(String newPattern)

regex	back to summary
private String regex()

sort	back to summary
public final FilePattern.Sort sort()

sort	back to summary
public final FilePattern sort(FilePattern.Sort newSort)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.jooq back to summary

public final Enum FilePattern.Sort

Class Inheritance

extends Enum<FilePattern.Sort>

java.lang.Object
java.lang.Enum
org.jooq.FilePattern.Sort

The sort algorithm to be applied to directory contents.

Field Summary

Modifier and Type	Field and Description
public static final FilePattern.Sort	ALPHANUMERIC Standard alphanumeric sorting.
public static final FilePattern.Sort	FLYWAY Flyway compatible sorting.
public static final FilePattern.Sort	NONE No explicit sorting (may be non deterministic, depending on the file system).
public static final FilePattern.Sort	SEMANTIC Semantic, version aware sorting (the default).

Constructor Summary

Access	Constructor and Description
private	Sort()

Method Summary

Modifier and Type	Method and Description
public static final FilePattern.Sort	of(String sort)
public static FilePattern.Sort	valueOf(String name)
public static FilePattern.Sort[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALPHANUMERIC	back to summary
public static final FilePattern.Sort ALPHANUMERIC Standard alphanumeric sorting. For example: version-1 version-10 version-2

ALPHANUMERIC

back to summary

public static final FilePattern.Sort ALPHANUMERIC

Standard alphanumeric sorting.

For example:

version-1
version-10
version-2

FLYWAY	back to summary
public static final FilePattern.Sort FLYWAY Flyway compatible sorting.

NONE	back to summary
public static final FilePattern.Sort NONE No explicit sorting (may be non deterministic, depending on the file system).

SEMANTIC	back to summary
public static final FilePattern.Sort SEMANTIC Semantic, version aware sorting (the default). For example: version-1 version-2 version-10

SEMANTIC

back to summary

public static final FilePattern.Sort SEMANTIC

Semantic, version aware sorting (the default).

For example:

version-1
version-2
version-10

Constructor Detail

Sort	back to summary
private Sort()

Method Detail

of	back to summary
public static final FilePattern.Sort of(String sort)

valueOf	back to summary
public static FilePattern.Sort valueOf(String name)

values	back to summary
public static FilePattern.Sort[] values()

public final Class FilePattern

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FilePattern.Sort

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail