Module com.aoapps.lang

Package com.aoapps.lang

Class Projects

java.lang.Object

com.aoapps.lang.Projects

public final class Projects
extends Object

Utilities that help when working with Package and/or Maven projects.

See java - Get Maven artifact version at runtime - Stack Overflow.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
static String	getRelease(String version)	Some projects are packaged with an additional release beyond their effective version number, separated by a single hypen.
static String	getVersion(Class<?> clazz, String groupId, String artifactId)	Gets the version from a Maven pom.properties file, falling back to Package.getImplementationVersion() then Package.getSpecificationVersion().
static String	getVersion(Class<?> clazz, String groupId, String artifactId, String def)	Gets the version from a Maven pom.properties file, falling back to Package.getImplementationVersion() then Package.getSpecificationVersion() then the provided default.
static String	getVersion(ClassLoader cl, String groupId, String artifactId)	Gets the version from a Maven pom.properties file and the given classloader.
static String	getVersion(ClassLoader cl, String groupId, String artifactId, String def)	Gets the version from a Maven pom.properties file and the given classloader, falling back to the provided default.
static String	getVersion(Package pk)	Gets the version from Package.getImplementationVersion(), falling back to Package.getSpecificationVersion().
static String	getVersion(Package pk, String def)	Gets the version from Package.getImplementationVersion(), falling back to Package.getSpecificationVersion() then the provided default.
static String	getVersion(String groupId, String artifactId)	Gets the version from a Maven pom.properties file.
static String	getVersion(String groupId, String artifactId, String def)	Gets the version from a Maven pom.properties file, falling back to the provided default.
static String	readVersion(String resource, InputStream in, String groupId, String artifactId)	Reads the pom.properties from the given input stream.
static String	readVersion(Function<String,InputStream> getResourceAsStream, String groupId, String artifactId)	Reads the pom.properties from the given source.
static String	stripRelease(String version)	Some projects are packaged with an additional release beyond their effective version number, separated by a single hypen.

Methods inherited from class java.lang.Object

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

Method Detail

readVersion

public static String readVersion(String resource,
                                 InputStream in,
                                 String groupId,
                                 String artifactId)
                          throws IOException

Reads the pom.properties from the given input stream.

Throws:

IOException

readVersion

public static String readVersion(Function<String,InputStream> getResourceAsStream,
                                 String groupId,
                                 String artifactId)
                          throws IOException

Reads the pom.properties from the given source.

Throws:

IOException

getVersion

public static String getVersion(ClassLoader cl,
                                String groupId,
                                String artifactId)

Gets the version from a Maven pom.properties file and the given classloader.

Parameters:

cl - The classloader to use. When null, will use ClassLoader.getSystemResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

getVersion

public static String getVersion(ClassLoader cl,
                                String groupId,
                                String artifactId,
                                String def)

Gets the version from a Maven pom.properties file and the given classloader, falling back to the provided default.

Parameters:

cl - The classloader to use. When null, will use ClassLoader.getSystemResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

getVersion

public static String getVersion(String groupId,
                                String artifactId)

Gets the version from a Maven pom.properties file.

Searches the unnamed module via ClassLoader.getResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

getVersion

public static String getVersion(String groupId,
                                String artifactId,
                                String def)

Gets the version from a Maven pom.properties file, falling back to the provided default.

Searches the unnamed module via ClassLoader.getResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

getVersion

public static String getVersion(Package pk)

Gets the version from Package.getImplementationVersion(), falling back to Package.getSpecificationVersion().

Returns:

The version or null when not found.

getVersion

public static String getVersion(Package pk,
                                String def)

Gets the version from Package.getImplementationVersion(), falling back to Package.getSpecificationVersion() then the provided default.

Returns:

The version or null when not found.

getVersion

public static String getVersion(Class<?> clazz,
                                String groupId,
                                String artifactId)

Gets the version from a Maven pom.properties file, falling back to Package.getImplementationVersion() then Package.getSpecificationVersion().

Supports named modules via Class.getResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

getVersion

public static String getVersion(Class<?> clazz,
                                String groupId,
                                String artifactId,
                                String def)

Gets the version from a Maven pom.properties file, falling back to Package.getImplementationVersion() then Package.getSpecificationVersion() then the provided default.

Supports named modules via Class.getResourceAsStream(java.lang.String).

Returns:

The version or null when not found.

stripRelease

public static String stripRelease(String version)

Some projects are packaged with an additional release beyond their effective version number, separated by a single hypen. This release is optional, and expected to be numeric only.

getRelease

public static String getRelease(String version)

Some projects are packaged with an additional release beyond their effective version number, separated by a single hypen. This release is optional, and expected to be numeric only.