org.codehaus.mojo.versions

Class DependencyUpdatesXmlRenderer

java.lang.Object

org.codehaus.mojo.versions.DependencyUpdatesXmlRenderer

public class DependencyUpdatesXmlRenderer
extends Object

XML renderer for DependencyUpdatesReport creates an xml file in target directory and writes report about available dependency/dependency management updates.

Since:

2.4

Author:

Illia Dubinin

Constructor Summary

Constructors

Constructor and Description
DependencyUpdatesXmlRenderer(Map<org.apache.maven.model.Dependency,ArtifactVersions> dependencyUpdates, Map<org.apache.maven.model.Dependency,ArtifactVersions> dependencyManagementUpdates, String outputFileName)

Method Summary

Modifier and Type	Method and Description
static String	getSummaryBlock(Collection<ArtifactVersions> allUpdates) Returns summary of dependency analysis result in xml format: current version, next available, next incremental, next minor and next major versions.
static String	getVersionsBlocks(ArtifactVersions versions) Returns xml report for current dependency state with following info: current version, next available version, next incremental/minor/major if available and status ('incremental available', 'minor available', 'major available' or 'no new available')
void	render() Makes report file with given name in target directory.
static String	wrapElement(String value, String tag) Method wraps value in xml tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyUpdatesXmlRenderer

public DependencyUpdatesXmlRenderer(Map<org.apache.maven.model.Dependency,ArtifactVersions> dependencyUpdates,
                                    Map<org.apache.maven.model.Dependency,ArtifactVersions> dependencyManagementUpdates,
                                    String outputFileName)

Method Detail

render

public void render()
            throws org.apache.maven.reporting.MavenReportException

Makes report file with given name in target directory.

Throws:

org.apache.maven.reporting.MavenReportException - if something went wrong

wrapElement

public static String wrapElement(String value,
                                 String tag)

Method wraps value in xml tag. In ex: to wrap foo in tag bar you have to pass foo as value and bar as tag. As a result you will get: foo

Parameters:

value - - string to wrap

tag - - name of tag

Returns:

value wrapped in xml tag

getSummaryBlock

public static String getSummaryBlock(Collection<ArtifactVersions> allUpdates)

Returns summary of dependency analysis result in xml format: current version, next available, next incremental, next minor and next major versions.

Parameters:

allUpdates - all dependencies versions

Returns:

summary in xml format

getVersionsBlocks

public static String getVersionsBlocks(ArtifactVersions versions)

Returns xml report for current dependency state with following info: current version, next available version, next incremental/minor/major if available and status ('incremental available', 'minor available', 'major available' or 'no new available')

Parameters:

versions - version info for dependency

Returns:

xml reports about current possible updates.