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

Class MavenModelScannerPlugin

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

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

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

public class MavenModelScannerPlugin
extends com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

Scans Maven model instances. This plugin requires an instance of MavenPomDescriptor in the scanner context which will be enriched.

Author:

ronald.kunzmann@buschmais.com

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
MavenModelScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(org.apache.maven.model.Model item, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected MavenPomDescriptor	createMavenPomDescriptor(org.apache.maven.model.Model model, com.buschmais.jqassistant.core.scanner.api.Scanner scanner) Create the descriptor and set base information.
Class<MavenPomDescriptor>	getDescriptorType()
Class<? extends org.apache.maven.model.Model>	getType()
void	initialize()
MavenPomDescriptor	scan(org.apache.maven.model.Model model, 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, getDirectoryPath, getProperties, getProperty, getScannerContext, getStringProperty, getTypeParameter, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenModelScannerPlugin

public MavenModelScannerPlugin()

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

Overrides:

initialize in class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

getType

public Class<? extends org.apache.maven.model.Model> getType()

Specified by:

getType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

Overrides:

getType in class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

getDescriptorType

public Class<MavenPomDescriptor> getDescriptorType()

Specified by:

getDescriptorType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

Overrides:

getDescriptorType in class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<org.apache.maven.model.Model,MavenPomDescriptor>

accepts

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

Throws:

IOException

scan

public MavenPomDescriptor scan(org.apache.maven.model.Model model,
                               String path,
                               com.buschmais.jqassistant.core.scanner.api.Scope scope,
                               com.buschmais.jqassistant.core.scanner.api.Scanner scanner)
                        throws IOException

Throws:

IOException

createMavenPomDescriptor

protected MavenPomDescriptor createMavenPomDescriptor(org.apache.maven.model.Model model,
                                                      com.buschmais.jqassistant.core.scanner.api.Scanner scanner)

Create the descriptor and set base information.

Parameters:

model - The model.

scanner - The scanner.

Returns:

The descriptor.