org.kuali.maven.plugins.graph.mojo.BaseGraphMojo Maven / Gradle / Ivy
/**
* Copyright 2011-2012 The Kuali Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ecl2.php
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.kuali.maven.plugins.graph.mojo;
import org.kuali.maven.plugins.graph.pojo.Conflicts;
import org.kuali.maven.plugins.graph.pojo.Direction;
import org.kuali.maven.plugins.graph.pojo.Display;
/**
*
*
*
*/
public abstract class BaseGraphMojo extends BaseMavenMojo {
/**
*
* Controls what dependencies are displayed on the graph by applying different filtering techniques. Valid options
* are PATH, TREE, and PT (path and tree).
*
*
*
* NOTE: Support for display types other than TREE should be considered experimental. PATH
* and PT are not fully implemented or tested. Use at your own risk.
*
*
*
* TREE prunes the dependency tree from the top down. Recursive traversal of transitive dependencies
* stops when a dependency does not match the filter criteria. Any further transitive dependencies in that part of
* the dependency tree are not displayed.
*
*
*
* PATH searches the entire tree for any dependencies matching the filter criteria. All matching
* dependencies are displayed. In addition, the dependencies in the path from any matching dependency back to the
* top of the dependency tree are displayed. Dependencies in the path from a matching dependency to the top of the
* tree are always displayed, even if they do not match the filter criteria themselves.
*
*
*
* PT is similar to PATH. The difference between PT and PATH is
* that PT shows the transitive dependencies of dependencies matching the filter criteria in addition
* to the dependencies in the path back to the top of the dependency tree.
*
*
* @parameter expression="${graph.display}" default-value="TREE"
*/
private Display display;
/**
*
* The title for the graph
*
*
* @parameter expression="${graph.title}" default-value="Dependency Graph for ${project.name}"
*/
private String title;
/**
*
* If true, the .dot text file Graphviz uses to draw the graph is retained
*
*
* @parameter expression="${graph.keepDotFile}" default-value="false"
*/
private boolean keepDotFile;
/**
*
* The direction for the graph layout. Valid values are TB, LR, BT, RL. Top to bottom, left to right, bottom to top,
* and right to left, respectively.
*
*
* @required
* @parameter expression="${graph.direction}" default-value="TB"
*/
private Direction direction;
/**
*
* If true, artifact group id's are displayed on the graph.
*
*
* @parameter expression="${graph.showGroupIds}" default-value="true"
*/
private boolean showGroupIds;
/**
*
* If true, duplicate dependencies are displayed on the graph.
*
*
* @parameter expression="${graph.showDuplicates}" default-value="false"
*/
private boolean showDuplicates;
/**
*
* Determines how conflicts in the dependency tree are displayed. Valid options are IGNORE,
* LABEL, and SHOW.
*
*
*
* IGNORE, ignores conflicts and draws the graph without any reference to them.
*
*
*
* LABEL, draws a red line with the word "conflict" for any spots in the dependency tree where there
* are conflicts.
*
*
*
* SHOW, draws a red line, and also shows what version of the artifact was conflicted out of the build.
*
*
*
* Maven supports the resolution of artifact versions by way of nearest-wins. That is, for any set of dependencies
* that share the same groupId:artifactId:type:classifier, the one declared nearest to the current project in the
* dependency tree will be selected for use.
*
*
* @parameter expression="${graph.conflicts}" default-value="IGNORE"
*/
private Conflicts conflicts;
/**
*
* If true, any dependency marked as optional will have all of its transitive dependencies displayed as optional
* also.
*
*
* @parameter expression="${graph.cascadeOptional}" default-value="true"
*/
private boolean cascadeOptional;
/**
*
* If true, any filters applied to the dependency tree are shown in the legend.
*
*
* @parameter expression="${graph.showLegend}" default-value="true"
*/
private boolean showLegend;
/**
*
* If true, the title for the graph will be displayed.
*
*
* @parameter expression="${graph.showTitle}" default-value="true"
*/
private boolean showTitle;
/**
*
* If true, the Graphviz "dot" binary is executed to produce a graph from the .dot text file
*
*
* @parameter expression="${graph.executeDot}" default-value="true"
*/
private boolean executeDot;
/**
*
* If true, the Maven build will continue even if the "dot" executable returns a non-zero exit value.
*
*
* @parameter expression="${graph.ignoreDotFailure}" default-value="false"
*/
private boolean ignoreDotFailure;
/**
*
* If true, skip invoking Graphviz if there are no dependencies to graph.
*
*
* @parameter expression="${graph.skipEmptyGraphs}" default-value="true"
*/
private boolean skipEmptyGraphs;
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public boolean isKeepDotFile() {
return keepDotFile;
}
public void setKeepDotFile(boolean keepDotFile) {
this.keepDotFile = keepDotFile;
}
public Direction getDirection() {
return direction;
}
public void setDirection(Direction direction) {
this.direction = direction;
}
public boolean isShowGroupIds() {
return showGroupIds;
}
public void setShowGroupIds(boolean showGroupIds) {
this.showGroupIds = showGroupIds;
}
public boolean isShowLegend() {
return showLegend;
}
public void setShowLegend(boolean showLegend) {
this.showLegend = showLegend;
}
public boolean isShowTitle() {
return showTitle;
}
public void setShowTitle(boolean showTitle) {
this.showTitle = showTitle;
}
public boolean isExecuteDot() {
return executeDot;
}
public void setExecuteDot(boolean executeDot) {
this.executeDot = executeDot;
}
public boolean isIgnoreDotFailure() {
return ignoreDotFailure;
}
public void setIgnoreDotFailure(boolean ignoreDotFailure) {
this.ignoreDotFailure = ignoreDotFailure;
}
public boolean isShowDuplicates() {
return showDuplicates;
}
public void setShowDuplicates(boolean showDuplicates) {
this.showDuplicates = showDuplicates;
}
public boolean isCascadeOptional() {
return cascadeOptional;
}
public void setCascadeOptional(boolean cascadeOptional) {
this.cascadeOptional = cascadeOptional;
}
public boolean isSkipEmptyGraphs() {
return skipEmptyGraphs;
}
public void setSkipEmptyGraphs(boolean skipEmptyGraphs) {
this.skipEmptyGraphs = skipEmptyGraphs;
}
public Display getDisplay() {
return display;
}
public void setDisplay(Display filterType) {
this.display = filterType;
}
public Conflicts getConflicts() {
return conflicts;
}
public void setConflicts(Conflicts conflicts) {
this.conflicts = conflicts;
}
}