com.atlassian.maven.plugins.clirr
Class ClirrRulesMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.clirr.AbstractClirrMojo
          org.codehaus.mojo.clirr.AbstractClirrCheckMojo
              org.codehaus.mojo.clirr.ClirrCheckMojo
                  com.atlassian.maven.plugins.clirr.ClirrRulesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class ClirrRulesMojo
extends org.codehaus.mojo.clirr.ClirrCheckMojo

Field Summary

protected java.lang.String[]	classTypes The class types to include.
protected java.lang.String[]	excludeRules A list of rules to exclude when checking for compatibility
protected java.lang.String	expectedFile A path to a text file containing a list of fully qualified method names that have differences
protected boolean	resolveDependentClasses Whether to resolve the transitive dependent classes
protected java.lang.String[]	rules A list of rules to apply when checking for compatibility
protected java.lang.String[]	transitiveExcludes A list of transitive dependent classes to exclude.
protected java.lang.String[]	transitiveIncludes A list of transitive dependent classes to include.

Fields inherited from class org.codehaus.mojo.clirr.AbstractClirrMojo

classesDirectory, comparisonArtifacts, comparisonVersion, excludes, factory, includes, localRepository, logResults, minSeverity, project, resolver, skip, textOutputFile, xmlOutputFile

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

ClirrRulesMojo()

Method Summary

void	execute()
protected org.codehaus.mojo.clirr.ClirrDiffListener	executeClirr(net.sf.clirr.core.Severity minSeverity)
protected void	executeClirr(net.sf.clirr.core.Severity severity, net.sf.clirr.core.DiffListener listener, net.sf.clirr.core.ClassFilter classFilter) //TODO move into AbstractClirrCheckMojo
protected net.sf.clirr.core.ClassFilter	getClassFilter(java.util.Set<net.sf.clirr.core.spi.JavaType> previousArtifactClasses)
protected com.google.common.base.Predicate<net.sf.clirr.core.ApiDifference>	getListenerFilter()
protected java.util.List<net.sf.clirr.core.DiffListener>	getListeners() //TODO move into AbstractClirrCheckMojo
protected net.sf.clirr.core.spi.JavaType[]	resPreviousReleaseClasses(net.sf.clirr.core.ClassFilter classFilter)
java.lang.String	toString()

Methods inherited from class org.codehaus.mojo.clirr.AbstractClirrCheckMojo

doExecute

Methods inherited from class org.codehaus.mojo.clirr.AbstractClirrMojo

canGenerate, convertSeverity, createClassLoader, createClassSet, executeClirr, getTransitiveDependencies, resolveArtifacts

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

transitiveIncludes

protected java.lang.String[] transitiveIncludes

A list of transitive dependent classes to include. These classes are included if they are method parameters or return types of the included classes. Values are specified in path pattern notation, e.g. com/atlassian/com/** /*Action* .

transitiveExcludes

protected java.lang.String[] transitiveExcludes

A list of transitive dependent classes to exclude. These classes are excluded even if they are method parameters or return types of the included classes. Values are specified in path pattern notation, e.g. com/atlassian/com/** /*Action* .

rules

protected java.lang.String[] rules

A list of rules to apply when checking for compatibility

excludeRules

protected java.lang.String[] excludeRules

A list of rules to exclude when checking for compatibility

resolveDependentClasses

protected boolean resolveDependentClasses

Whether to resolve the transitive dependent classes

classTypes

protected java.lang.String[] classTypes

The class types to include. Valid values are INTERFACE, CLASS, NOINTERFACE_CLASS, ALL A NOINTERFACE_CLASS is a class that does not have an interface

expectedFile

protected java.lang.String expectedFile

A path to a text file containing a list of fully qualified method names that have differences

Constructor Detail

ClirrRulesMojo

public ClirrRulesMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class org.codehaus.mojo.clirr.AbstractClirrMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

executeClirr

protected org.codehaus.mojo.clirr.ClirrDiffListener executeClirr(net.sf.clirr.core.Severity minSeverity)
                                                          throws org.apache.maven.plugin.MojoExecutionException,
                                                                 org.apache.maven.plugin.MojoFailureException

Overrides:

executeClirr in class org.codehaus.mojo.clirr.AbstractClirrMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getClassFilter

protected net.sf.clirr.core.ClassFilter getClassFilter(java.util.Set<net.sf.clirr.core.spi.JavaType> previousArtifactClasses)
                                                throws org.apache.maven.plugin.MojoExecutionException,
                                                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getListeners

protected java.util.List<net.sf.clirr.core.DiffListener> getListeners()
                                                               throws org.apache.maven.plugin.MojoExecutionException

//TODO move into AbstractClirrCheckMojo

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

resPreviousReleaseClasses

protected net.sf.clirr.core.spi.JavaType[] resPreviousReleaseClasses(net.sf.clirr.core.ClassFilter classFilter)
                                                              throws org.apache.maven.plugin.MojoFailureException,
                                                                     org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

executeClirr

protected void executeClirr(net.sf.clirr.core.Severity severity,
                            net.sf.clirr.core.DiffListener listener,
                            net.sf.clirr.core.ClassFilter classFilter)
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException

//TODO move into AbstractClirrCheckMojo

Parameters:

severity -

listener -

classFilter -

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getListenerFilter

protected com.google.common.base.Predicate<net.sf.clirr.core.ApiDifference> getListenerFilter()
                                                                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException