Package net.stoerr.ai.aigenpipeline.framework.task

Class FileLookupHelper

java.lang.Object

net.stoerr.ai.aigenpipeline.framework.task.FileLookupHelper

public class FileLookupHelper
extends Object

Makes it easy to find files to process with AIGenerationTask etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Pattern	BINARYFILEPATTERN	Pattern matching file names of files which have binary content (*.jpg, *.gif, *.jar etc.), which we ignore in the search.
protected File	directory
protected static int	FILE_MAXSIZE	The maximum filesize we search in.
static String	HTML_PATTERN
protected static Logger	LOG
protected static Pattern	NOMETAPREFIXPATTERN	A pattern matching a prefix of a file name that ends with a / and has no meta characters of the FileSystem.getPathMatcher(String) in it.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileLookupHelper(String path)

Method Summary

Modifier and Type	Method	Description
File	file(String relpath)	File relative to repository root - that doesn't need to exist (might be output file).
List<File>	files(String relpathDirectory, String filePathPattern, boolean recursive)	Files in a directory, matching an ant style pattern - more specifically like FileSystem.getPathMatcher(String) glob patterns (without "glob:" prefix).
List<File>	filesContaining(String relpathDirectory, String filePathPattern, Pattern pattern, boolean recursive)	All files matching a filePathRegex that contain a pattern.
static FileLookupHelper	fromEnv(String envVar, String relativePath)	Make repository from environment variable.
static FileLookupHelper	fromPath(String... relativePaths)
File	javaFile(String fullName)	File from full java class name.
File	javaMdFile(String fullName)	File for documenting a full java class name.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

HTML_PATTERN

public static final String HTML_PATTERN

See Also:

Constant Field Values

NOMETAPREFIXPATTERN

protected static final Pattern NOMETAPREFIXPATTERN

A pattern matching a prefix of a file name that ends with a / and has no meta characters of the FileSystem.getPathMatcher(String) in it.

FILE_MAXSIZE

protected static final int FILE_MAXSIZE

The maximum filesize we search in.

See Also:

Constant Field Values

BINARYFILEPATTERN

protected static final Pattern BINARYFILEPATTERN

Pattern matching file names of files which have binary content (*.jpg, *.gif, *.jar etc.), which we ignore in the search.

directory

protected final File directory

Constructor Detail

FileLookupHelper

protected FileLookupHelper(String path)

Method Detail

fromPath

public static FileLookupHelper fromPath(String... relativePaths)

fromEnv

public static FileLookupHelper fromEnv(@Nonnull
                                       String envVar,
                                       @Nullable
                                       String relativePath)

Make repository from environment variable.

file

public File file(String relpath)

File relative to repository root - that doesn't need to exist (might be output file).

files

@Nonnull
public List<File> files(@Nonnull
                        String relpathDirectory,
                        @Nullable
                        String filePathPattern,
                        boolean recursive)

Files in a directory, matching an ant style pattern - more specifically like FileSystem.getPathMatcher(String) glob patterns (without "glob:" prefix).

Parameters:

relpathDirectory - the directory relative to the repository root

filePathPattern - the file pattern to match, see FileSystem.getPathMatcher(String) glob pattern

recursive - whether to recurse into subdirectories

Returns:

a list of files

See Also:

FileSystem.getPathMatcher(String)

filesContaining

@Nonnull
public List<File> filesContaining(@Nonnull
                                  String relpathDirectory,
                                  @Nonnull
                                  String filePathPattern,
                                  @Nonnull
                                  Pattern pattern,
                                  boolean recursive)

All files matching a filePathRegex that contain a pattern.

Parameters:

relpathDirectory - the directory relative to the repository root

filePathPattern - the file pattern to match

pattern - the regex to look for in the file content

recursive - whether to recurse into subdirectories

Returns:

a list of files

javaFile

@Nonnull
public File javaFile(@Nonnull
                     String fullName)

File from full java class name.

javaMdFile

@Nonnull
public File javaMdFile(@Nonnull
                       String fullName)

File for documenting a full java class name.