Package com.polarion.alm.builder.spi

Interface IBuildArtifactRecognizer

All Known Implementing Classes:

AbstractNonMavenBuildArtifactRecognizer

public interface IBuildArtifactRecognizer

Build artifact recognizer.

Judging by source repository content it is able to recognize all available build artifacts of some type.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IBuildArtifactRecognizer.IRecognizedBuildArtifact	Recognized build artifact.

Method Summary

Modifier and Type	Method	Description
boolean	isDefaultRecognizer()	Whether this is a default recognizer.
Collection	recognizeBuildArtifacts(ISourceRepository repo, ILocation folder, ILocation rootFolder)	Try to recognize all known build artifacts.

Method Details

isDefaultRecognizer

boolean isDefaultRecognizer()

Whether this is a default recognizer.

Default recognizer is recognizer which is not driven by some file or collection of files, but uses heuristics to derive build artifact from folder structure ("auto" builds, for example).

Returned value must not change.

Returns:

true if this is default recognizer

recognizeBuildArtifacts

Collection recognizeBuildArtifacts(ISourceRepository repo,
 ILocation folder,
 ILocation rootFolder)
                            throws GenericBuilderException

Try to recognize all known build artifacts.

It is up to the caller to tag given location if he wants to recognize in different repository tags.

Parameters:

repo - source repository

folder - denotes folder and its subfolders which should be used as a base for recognition

rootFolder - denotes root folder used for location relativization or null if folder and rootFolder are the same

Returns:

Collection of IBuildArtifactRecognizer.IRecognizedBuildArtifacts (not null)

Throws:

IllegalArgumentException - if repo is null

IllegalArgumentException - if folder is null

GenericBuilderException - if error occurs