org.apache.maven.surefire.providerapi
Interface ProviderParameters

All Known Implementing Classes:

BaseProviderFactory

public interface ProviderParameters

Injected into the providers upon provider construction. Allows the provider to request services and data it needs.

NOTE: This class is part of the proposed public api for surefire providers from 2.7 and up. It may still be subject to changes, even for minor revisions.

The api covers this interface and all the types reachable from it. And nothing else.

Author:

Kristian Rosenvold

Method Summary

ConsoleLogger	getConsoleLogger() Gets a logger intended for console output.
DirectoryScanner	getDirectoryScanner() Deprecated. Use scanresult instead, as of version 2.12.2. Will be removed in next major version.
DirectoryScannerParameters	getDirectoryScannerParameters() Deprecated. Use scanresult instead, as of version 2.12.2. Will be removed in next major version.
Properties	getProviderProperties() The per-provider specific properties that may come all the way from the plugin's properties setting.
ReporterConfiguration	getReporterConfiguration() The raw parameters used in creating the ReporterManagerFactory
ReporterFactory	getReporterFactory() Provides features for creating reporting objects
RunOrderCalculator	getRunOrderCalculator() Provides a service to calculate run order of tests.
ScanResult	getScanResult() Provides the result of the directory scan performed in the plugin
TestArtifactInfo	getTestArtifactInfo() Artifact info about the artifact used to autodetect provider
ClassLoader	getTestClassLoader() The class loader for the tests
TestRequest	getTestRequest() Contains information about requested test suites or individual tests from the command line.

Method Detail

getDirectoryScanner

DirectoryScanner getDirectoryScanner()

Deprecated. Use scanresult instead, as of version 2.12.2. Will be removed in next major version.

Provides a directory scanner that enforces the includes/excludes parameters that were passed to surefire. See #getDirectoryScannerParameters for details

Returns:

The directory scanner

getScanResult

ScanResult getScanResult()

Provides the result of the directory scan performed in the plugin

Returns:

The scan result

getRunOrderCalculator

RunOrderCalculator getRunOrderCalculator()

Provides a service to calculate run order of tests. Applied after directory scanning.

Returns:

A RunOrderCalculator

getReporterFactory

ReporterFactory getReporterFactory()

Provides features for creating reporting objects

Returns:

A ReporterFactory that allows the creation of one or more ReporterManagers

getConsoleLogger

ConsoleLogger getConsoleLogger()

Gets a logger intended for console output.

This output is inteded for provider-oriented messages that are not attached to a single test-set and will normally be written to something console-like immediately.

Returns:

A console logger

getDirectoryScannerParameters

DirectoryScannerParameters getDirectoryScannerParameters()

Deprecated. Use scanresult instead, as of version 2.12.2. Will be removed in next major version.

The raw parameters used in creating the directory scanner

Returns:

The parameters

getReporterConfiguration

ReporterConfiguration getReporterConfiguration()

The raw parameters used in creating the ReporterManagerFactory

Returns:

The reporter configuration

getTestRequest

TestRequest getTestRequest()

Contains information about requested test suites or individual tests from the command line.

Returns:

The testRequest

getTestClassLoader

ClassLoader getTestClassLoader()

The class loader for the tests

Returns:

the classloader

getProviderProperties

Properties getProviderProperties()

The per-provider specific properties that may come all the way from the plugin's properties setting.

Returns:

the provider specific properties

getTestArtifactInfo

TestArtifactInfo getTestArtifactInfo()

Artifact info about the artifact used to autodetect provider

Returns:

The artifactinfo, or null if autodetect was not used.