com.helger.photon.basic.buildinfo

Class BuildInfo

java.lang.Object

com.helger.photon.basic.buildinfo.BuildInfo

public final class BuildInfo
extends Object

This class allows you to read the buildinfo.xml files generated by the buildinfo-maven-plugin.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BuildInfo.SinceBuildInfoV2 Indicate that certain fields are only available from V2

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILDINFO_FILENAME The default filename as stored in the JAR files.

Constructor Summary

Constructors

Constructor and Description
BuildInfo(Map<String,String> aMap)

Method Summary

Methods

Modifier and Type	Method and Description
static BuildInfo	createFromResource(com.helger.commons.io.IReadableResource aRes)
Map<String,String>	getAllEnvVars()
Map<String,String>	getAllSystemProperties()
boolean	getBoolean(String sKey)
org.joda.time.DateTime	getBuildDateTime()
String	getBuildPluginArtifactID(int nIndex)
String	getBuildPluginConfiguration(int nIndex)
int	getBuildPluginCount()
String	getBuildPluginGroupID(int nIndex)
String	getBuildPluginKey(int nIndex)
String	getBuildPluginVersion(int nIndex)
String	getDependencyArtifactID(int nIndex)
String	getDependencyClassifier(int nIndex)
int	getDependencyCount()
String	getDependencyGroupID(int nIndex)
String	getDependencyManagementKey(int nIndex)
String	getDependencyScope(int nIndex)
String	getDependencySystemPath(int nIndex)
String	getDependencyType(int nIndex)
String	getDependencyVersion(int nIndex)
int	getInt(String sKey)
long	getLong(String sKey)
String	getParentProjectArtifactID()
String	getParentProjectGroupID()
String	getParentProjectName()
String	getParentProjectVersion()
String	getProjectArtifactID()
String	getProjectGroupID()
String	getProjectName()
String	getProjectPackaging()
String	getProjectVersion()
String	getString(String sKey) Get a string property.
int	getVersion()
boolean	isDependencyOptional(int nIndex)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BUILDINFO_FILENAME

public static final String BUILDINFO_FILENAME

The default filename as stored in the JAR files.

See Also:

Constant Field Values

Constructor Detail

BuildInfo

public BuildInfo(@Nonnull
         Map<String,String> aMap)

Method Detail

getVersion

@Nonnegative
public int getVersion()

Returns:

The build info version number.

getString

@Nullable
public String getString(@Nullable
                        String sKey)

Get a string property.

Parameters:

sKey - The key to retrieve

Returns:

null if the key does not exist

getLong

public long getLong(@Nullable
           String sKey)

getInt

public int getInt(@Nullable
         String sKey)

getBoolean

public boolean getBoolean(@Nullable
                 String sKey)

getProjectGroupID

@Nonnull
public String getProjectGroupID()

getProjectArtifactID

@Nonnull
public String getProjectArtifactID()

getProjectVersion

@Nonnull
public String getProjectVersion()

getProjectName

@Nonnull
public String getProjectName()

getProjectPackaging

@Nonnull
public String getProjectPackaging()

getParentProjectGroupID

@Nonnull
public String getParentProjectGroupID()

getParentProjectArtifactID

@Nonnull
public String getParentProjectArtifactID()

getParentProjectVersion

@Nonnull
public String getParentProjectVersion()

getParentProjectName

@Nonnull
public String getParentProjectName()

getBuildPluginCount

@Nonnegative
public int getBuildPluginCount()

getBuildPluginGroupID

@Nonnull
public String getBuildPluginGroupID(@Nonnegative
                                   int nIndex)

getBuildPluginArtifactID

@Nonnull
public String getBuildPluginArtifactID(@Nonnegative
                                      int nIndex)

getBuildPluginVersion

@Nonnull
public String getBuildPluginVersion(@Nonnegative
                                   int nIndex)

getBuildPluginConfiguration

@Nonnull
public String getBuildPluginConfiguration(@Nonnegative
                                         int nIndex)

getBuildPluginKey

@BuildInfo.SinceBuildInfoV2
public String getBuildPluginKey(@Nonnegative
                                                  int nIndex)

getDependencyCount

@Nonnegative
@BuildInfo.SinceBuildInfoV2
public int getDependencyCount()

getDependencyGroupID

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyGroupID(@Nonnegative
                                                             int nIndex)

getDependencyArtifactID

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyArtifactID(@Nonnegative
                                                                int nIndex)

getDependencyVersion

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyVersion(@Nonnegative
                                                             int nIndex)

getDependencyType

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyType(@Nonnegative
                                                          int nIndex)

getDependencyClassifier

@Nullable
@BuildInfo.SinceBuildInfoV2
public String getDependencyClassifier(@Nonnegative
                                                                 int nIndex)

getDependencyScope

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyScope(@Nonnegative
                                                           int nIndex)

getDependencySystemPath

@Nullable
@BuildInfo.SinceBuildInfoV2
public String getDependencySystemPath(@Nonnegative
                                                                 int nIndex)

isDependencyOptional

@BuildInfo.SinceBuildInfoV2
public boolean isDependencyOptional(@Nonnegative
                                                      int nIndex)

getDependencyManagementKey

@Nonnull
@BuildInfo.SinceBuildInfoV2
public String getDependencyManagementKey(@Nonnegative
                                                                   int nIndex)

Parameters:

nIndex - dependency index

Returns:

groupID:artifactid:type - no version info!

getBuildDateTime

@Nonnull
public org.joda.time.DateTime getBuildDateTime()

getAllSystemProperties

@Nonnull
@ReturnsMutableCopy
public Map<String,String> getAllSystemProperties()

getAllEnvVars

@Nonnull
@ReturnsMutableCopy
public Map<String,String> getAllEnvVars()

toString

public String toString()

Overrides:

toString in class Object

createFromResource

@Nullable
public static BuildInfo createFromResource(@Nonnull
                                    com.helger.commons.io.IReadableResource aRes)