hudson.plugins.tasks.parser
Class WorkspaceScanner

java.lang.Object
  hudson.plugins.tasks.parser.WorkspaceScanner

All Implemented Interfaces:

hudson.FilePath.FileCallable<TasksParserResult>, Serializable

public class WorkspaceScanner
extends Object
implements hudson.FilePath.FileCallable<TasksParserResult>

Scans the workspace and records the found tasks. Each file is then classified, i.e., a module and package is guessed and assigned.

Author:

Ulli Hafner

See Also:

Serialized Form

Constructor Summary

WorkspaceScanner(String filePattern, String excludeFilePattern, String defaultEncoding, String high, String normal, String low, boolean ignoreCase, boolean shouldDetectModules)
Creates a new instance of WorkspaceScanner.

WorkspaceScanner(String filePattern, String excludeFilePattern, String defaultEncoding, String high, String normal, String low, boolean caseSensitive, String moduleName)
Creates a new instance of WorkspaceScanner.

WorkspaceScanner(String filePattern, String excludeFilePattern, String defaultEncoding, String high, String normal, String low, boolean caseSensitive, String moduleName, List<String> modules)
Creates a new instance of WorkspaceScanner.

Method Summary

String	getPrefix() Returns the prefix.
TasksParserResult	invoke(File workspace, hudson.remoting.VirtualChannel channel)
protected void	log(String message) Logs the specified message.
void	setPrefix(String prefix) Sets the prefix to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceScanner

public WorkspaceScanner(String filePattern,
                        String excludeFilePattern,
                        String defaultEncoding,
                        String high,
                        String normal,
                        String low,
                        boolean ignoreCase,
                        boolean shouldDetectModules)

Creates a new instance of WorkspaceScanner.

Parameters:

filePattern - ant file-set pattern to scan for files

excludeFilePattern - ant file-set pattern to exclude from scan

defaultEncoding - the default encoding to be used when reading and parsing files

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

ignoreCase - if case should be ignored during matching

shouldDetectModules - determines whether module names should be derived from Maven POM or Ant build files

WorkspaceScanner

public WorkspaceScanner(String filePattern,
                        String excludeFilePattern,
                        String defaultEncoding,
                        String high,
                        String normal,
                        String low,
                        boolean caseSensitive,
                        String moduleName)

Creates a new instance of WorkspaceScanner.

Parameters:

filePattern - ant file-set pattern to scan for files

excludeFilePattern - ant file-set pattern to exclude from scan

defaultEncoding - the default encoding to be used when reading and parsing files

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

caseSensitive - determines whether the scanner should work case sensitive

moduleName - the maven module name

WorkspaceScanner

public WorkspaceScanner(String filePattern,
                        String excludeFilePattern,
                        String defaultEncoding,
                        String high,
                        String normal,
                        String low,
                        boolean caseSensitive,
                        String moduleName,
                        List<String> modules)

Creates a new instance of WorkspaceScanner.

Parameters:

filePattern - ant file-set pattern to scan for files

excludeFilePattern - ant file-set pattern to exclude from scan

defaultEncoding - the default encoding to be used when reading and parsing files

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

caseSensitive - determines whether the scanner should work case sensitive

moduleName - the maven module name

Method Detail

log

protected void log(String message)

Logs the specified message.

Parameters:

message - the message

setPrefix

public void setPrefix(String prefix)

Sets the prefix to the specified value.

Parameters:

prefix - the value to set

getPrefix

public String getPrefix()

Returns the prefix.

Returns:

the prefix

invoke

public TasksParserResult invoke(File workspace,
                                hudson.remoting.VirtualChannel channel)
                         throws IOException,
                                InterruptedException

Specified by:

invoke in interface hudson.FilePath.FileCallable<TasksParserResult>

Throws:

IOException

InterruptedException