Package io.jenkins.plugins.util

Class AgentFileVisitor<T extends Serializable>

java.lang.Object

jenkins.MasterToSlaveFileCallable<AgentFileVisitor.FileVisitorResult<T>>

io.jenkins.plugins.util.AgentFileVisitor<T>

Type Parameters:

T - the type of the results

All Implemented Interfaces:

FilePath.FileCallable<AgentFileVisitor.FileVisitorResult<T>>, Serializable, org.jenkinsci.remoting.RoleSensitive

public abstract class AgentFileVisitor<T extends Serializable>
extends MasterToSlaveFileCallable<AgentFileVisitor.FileVisitorResult<T>>

Finds all files that match a specified Ant file pattern and visits these files with the processing method processFile(Path, Charset, FilteredLog), that has to be implemented by concrete subclasses. This callable will be invoked on an agent so all fields and the returned list of results need to be Serializable.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgentFileVisitor.FileVisitorResult<T extends Serializable>	The results for all found files.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AgentFileVisitor(String filePattern, String encoding, boolean followSymbolicLinks, boolean errorOnEmptyFiles)	Creates a new instance of AgentFileVisitor.

Method Summary

Modifier and Type	Method	Description
final AgentFileVisitor.FileVisitorResult<T>	invoke(File workspace, hudson.remoting.VirtualChannel channel)
protected String	plural(int count, String itemName)	Creates the correct singular or plural form of the specified word depending on the size of the elements.
protected abstract Optional<T>	processFile(Path file, Charset charset, edu.hm.hafner.util.FilteredLog log)

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 Details

AgentFileVisitor

protected AgentFileVisitor(String filePattern,
 String encoding,
 boolean followSymbolicLinks,
 boolean errorOnEmptyFiles)

Creates a new instance of AgentFileVisitor.

Parameters:

filePattern - ant file-set pattern to scan for files to parse

encoding - encoding of the files to parse

followSymbolicLinks - determines whether the visitor should traverse symbolic links

errorOnEmptyFiles - determines whether the visitor should log errors if a file is empty

Method Details

invoke

public final AgentFileVisitor.FileVisitorResult<T> invoke(File workspace,
 hudson.remoting.VirtualChannel channel)

plural

protected String plural(int count,
 String itemName)

Creates the correct singular or plural form of the specified word depending on the size of the elements.

Parameters:

count - the count of elements

itemName - the name of the items (singular)

Returns:

the message

processFile

protected abstract Optional<T> processFile(Path file,
 Charset charset,
 edu.hm.hafner.util.FilteredLog log)