net.openhft.chronicle.core.pom

Class PomProperties

java.lang.Object

net.openhft.chronicle.core.pom.PomProperties

public final class PomProperties
extends Object

Access to Maven build metadata at runtime.

It loads the pom.properties resource for a given groupId and artifactId, allowing callers to inspect version and other build-time information.

All methods require non-null parameters. Passing null results in a NullPointerException.

Example:

 Properties props = PomProperties.create("net.openhft", "chronicle-core");
 String version = props.getProperty("version");
 

Method Summary

Modifier and Type	Method and Description
static @NotNull Properties	create(@NotNull String groupId, @NotNull String artifactId) Creates and returns a new instance of Properties for the provided parameters.
static String	version(@NotNull String groupId, @NotNull String artifactId) Returns the GAV version for the provided parameters, or "unknown" if the version cannot be determined.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NotNull
public static @NotNull Properties create(@NotNull
                                                  @NotNull String groupId,
                                                  @NotNull
                                                  @NotNull String artifactId)

Creates and returns a new instance of Properties for the provided parameters.

The provided libraryName is used to pick up properties from a resource named /META-INF/maven/${groupId}/${artifactId}/pom.properties e.g. "/META-INF/maven/net.openhft/chronicle-queue/pom.properties". If no such resource exist, an empty Properties instance is returned.

Parameters:

groupId - name of the group (e.g. net.openhft)

artifactId - name of the library (e.g. chronicle-queue)

Returns:

a new instance of Properties for the provided parameters.

version

public static String version(@NotNull
                             @NotNull String groupId,
                             @NotNull
                             @NotNull String artifactId)

Returns the GAV version for the provided parameters, or "unknown" if the version cannot be determined.

The provided libraryName is used the same way as for create(String, String).

Parameters:

groupId - name of the group (e.g. net.openhft)

artifactId - name of the library (e.g. chronicle-queue)

Returns:

the GAV version for the provided parameters, or "unknown" if the version cannot be determined

See Also:

create(String, String)