org.codehaus.mojo.jaxb2.shared.version

Class DependsFileParser

java.lang.Object

org.codehaus.mojo.jaxb2.shared.version.DependsFileParser

public final class DependsFileParser
extends Object

Trivial parser to handle depends-plugin-style files.

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILDTIME_KEY The key where the build time as found within the dependencies.properties file is found.
static String	OWN_ARTIFACTID_KEY The key holding the artifactId of this plugin (within the dependencies.properties file).
static String	OWN_GROUPID_KEY The key holding the groupId of this plugin (within the dependencies.properties file).
static String	OWN_VERSION_KEY The key holding the version of this plugin (within the dependencies.properties file).

Method Summary

Modifier and Type	Method and Description
static SortedMap<String,DependencyInfo>	createDependencyInfoMap(SortedMap<String,String> versionMap) Converts a SortedMap received from a getVersionMap call to hold DependencyInfo values, and keys on the form groupId/artifactId.
static SortedMap<String,String>	getVersionMap(String artifactId) Extracts all build-time dependency information from a dependencies.properties file embedded in this plugin's JAR.
static SortedMap<String,String>	getVersionMap(URL anURL) Extracts all build-time dependency information from a dependencies.properties file embedded in this plugin's JAR.

Methods inherited from class java.lang.Object

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

Field Detail

BUILDTIME_KEY

public static final String BUILDTIME_KEY

The key where the build time as found within the dependencies.properties file is found.

See Also:

Constant Field Values

OWN_ARTIFACTID_KEY

public static final String OWN_ARTIFACTID_KEY

The key holding the artifactId of this plugin (within the dependencies.properties file).

See Also:

Constant Field Values

OWN_GROUPID_KEY

public static final String OWN_GROUPID_KEY

The key holding the groupId of this plugin (within the dependencies.properties file).

See Also:

Constant Field Values

OWN_VERSION_KEY

public static final String OWN_VERSION_KEY

The key holding the version of this plugin (within the dependencies.properties file).

See Also:

Constant Field Values

Method Detail

getVersionMap

public static SortedMap<String,String> getVersionMap(String artifactId)

Extracts all build-time dependency information from a dependencies.properties file embedded in this plugin's JAR.

Parameters:

artifactId - This plugin's artifactId.

Returns:

A SortedMap relating [groupId]/[artifactId] keys to DependencyInfo values.

Throws:

IllegalStateException - if no artifact in the current Thread's context ClassLoader contained the supplied artifactNamePart.

getVersionMap

public static SortedMap<String,String> getVersionMap(URL anURL)

Extracts all build-time dependency information from a dependencies.properties file embedded in this plugin's JAR.

Parameters:

anURL - The non-empty URL to a dependencies.properties file.

Returns:

A SortedMap holding all entries in the dependencies.properties file, plus its build time which is found under the buildtime key.

Throws:

IllegalStateException - if no artifact in the current Thread's context ClassLoader contained the supplied artifactNamePart.

createDependencyInfoMap

public static SortedMap<String,DependencyInfo> createDependencyInfoMap(SortedMap<String,String> versionMap)

Converts a SortedMap received from a getVersionMap call to hold DependencyInfo values, and keys on the form groupId/artifactId.

Parameters:

versionMap - A non-null Map, as received from a call to getVersionMap.

Returns:

a SortedMap received from a getVersionMap call to hold DependencyInfo values, and keys on the form groupId/artifactId.