com.buschmais.jqassistant.plugin.maven3.impl.scanner

Class MavenProjectScannerPlugin

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.project.MavenProject,MavenProjectDirectoryDescriptor>

com.buschmais.jqassistant.plugin.maven3.impl.scanner.MavenProjectScannerPlugin

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<org.apache.maven.project.MavenProject,MavenProjectDirectoryDescriptor>

public class MavenProjectScannerPlugin
extends com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.project.MavenProject,MavenProjectDirectoryDescriptor>

A scanner plugin for maven projects.

Nested Class Summary

Nested classes/interfaces inherited from interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin.Requires

Constructor Summary

Constructors

Constructor and Description
MavenProjectScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(org.apache.maven.project.MavenProject item, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected <T extends MavenProjectDescriptor> T	resolveProject(org.apache.maven.project.MavenProject project, Class<T> expectedType, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) Resolves a maven project.
MavenProjectDirectoryDescriptor	scan(org.apache.maven.project.MavenProject project, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope, com.buschmais.jqassistant.core.scanner.api.Scanner scanner)

Methods inherited from class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin

configure, configure, equals, getBooleanProperty, getDescriptorType, getDirectoryPath, getProperties, getProperty, getScannerContext, getStringProperty, getType, getTypeParameter, hashCode, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenProjectScannerPlugin

public MavenProjectScannerPlugin()

Method Detail

accepts

public boolean accepts(org.apache.maven.project.MavenProject item,
                       String path,
                       com.buschmais.jqassistant.core.scanner.api.Scope scope)
                throws IOException

Throws:

IOException

scan

public MavenProjectDirectoryDescriptor scan(org.apache.maven.project.MavenProject project,
                                            String path,
                                            com.buschmais.jqassistant.core.scanner.api.Scope scope,
                                            com.buschmais.jqassistant.core.scanner.api.Scanner scanner)
                                     throws IOException

Throws:

IOException

resolveProject

protected <T extends MavenProjectDescriptor> T resolveProject(org.apache.maven.project.MavenProject project,
                                                              Class<T> expectedType,
                                                              com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

Resolves a maven project.

Type Parameters:

T - The expected descriptor type.

Parameters:

project - The project

expectedType - The expected descriptor type.

scannerContext - The scanner context.

Returns:

The maven project descriptor.