io.jenkins.plugins.metrics.util

Class FileFinder

java.lang.Object

jenkins.MasterToSlaveFileCallable<String[]>

io.jenkins.plugins.metrics.util.FileFinder

All Implemented Interfaces:

hudson.FilePath.FileCallable<String[]>, Serializable, org.jenkinsci.remoting.RoleSensitive

public class FileFinder
extends jenkins.MasterToSlaveFileCallable<String[]>

Scans the workspace and finds all files matching a given ant pattern.

Author:

Ullrich Hafner https://github.com/jenkinsci/warnings-ng-plugin/blob/master/src/main/java/io/jenkins/plugins/analysis/core/util/FileFinder.java

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileFinder(String includesPattern) Creates a new instance of FileFinder.
FileFinder(String includesPattern, String excludesPattern) Creates a new instance of FileFinder.
FileFinder(String includesPattern, String excludesPattern, boolean followSymlinks) Creates a new instance of FileFinder.

Method Summary

Modifier and Type	Method and Description
String[]	find(File workspace) Returns an array with the file names of the specified file pattern that have been found in the workspace.
String[]	invoke(File workspace, hudson.remoting.VirtualChannel channel) Returns an array with the file names of the specified file pattern that have been found in the workspace.

Methods inherited from class jenkins.MasterToSlaveFileCallable

checkRoles

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFinder

public FileFinder(String includesPattern)

Creates a new instance of FileFinder.

Parameters:

includesPattern - the ant file includes pattern to scan for

FileFinder

public FileFinder(String includesPattern,
                  String excludesPattern)

Creates a new instance of FileFinder.

Parameters:

includesPattern - the ant file includes pattern to scan for

excludesPattern - the ant file excludes pattern to scan for

FileFinder

public FileFinder(String includesPattern,
                  String excludesPattern,
                  boolean followSymlinks)

Creates a new instance of FileFinder.

Parameters:

includesPattern - the ant file includes pattern to scan for

excludesPattern - the ant file excludes pattern to scan for

followSymlinks - if the scanner should traverse symbolic links

Method Detail

invoke

public String[] invoke(File workspace,
                       hudson.remoting.VirtualChannel channel)
                throws IOException

Returns an array with the file names of the specified file pattern that have been found in the workspace.

Parameters:

workspace - root directory of the workspace

channel - not used

Returns:

the file names of all found files

Throws:

IOException - if the workspace could not be read

find

public String[] find(File workspace)

Returns an array with the file names of the specified file pattern that have been found in the workspace.

Parameters:

workspace - root directory of the workspace

Returns:

the file names of all found files