Package io.jenkins.plugins.util

Klasse AgentFileVisitor<T extends Serializable>

java.lang.Object

jenkins.MasterToSlaveFileCallable<AgentFileVisitor.FileVisitorResult<T>>

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

Typparameter:

T - the type of the results

Alle implementierten Schnittstellen:

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.

Autor:

Ullrich Hafner

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	AgentFileVisitor.FileVisitorResult<T extends Serializable>	The results for all found files.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AgentFileVisitor(String filePattern, String encoding, boolean followSymbolicLinks, boolean errorOnEmptyFiles)	Creates a new instance of AgentFileVisitor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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)

Von Klasse geerbte Methoden jenkins.MasterToSlaveFileCallable

checkRoles

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

AgentFileVisitor

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

Creates a new instance of AgentFileVisitor.

Parameter:

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

Methodendetails

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.

Parameter:

count - the count of elements

itemName - the name of the items (singular)

Gibt zurück:

the message

processFile

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