Package org.springframework.boot.info

Class GitProperties

java.lang.Object

org.springframework.boot.info.InfoProperties

org.springframework.boot.info.GitProperties

All Implemented Interfaces:

Iterable<InfoProperties.Entry>

@ImportRuntimeHints(org.springframework.boot.info.GitProperties.GitPropertiesRuntimeHints.class)
public class GitProperties
extends InfoProperties

Provide git-related information such as commit id and time.

Since:

1.4.0

Author:

Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.info.InfoProperties

InfoProperties.Entry

Constructor Summary

Constructors

Constructor	Description
GitProperties(Properties entries)

Method Summary

Modifier and Type	Method	Description
String	getBranch()	Return the name of the branch or null.
String	getCommitId()	Return the full id of the commit or null.
Instant	getCommitTime()	Return the timestamp of the commit or null.
String	getShortCommitId()	Return the abbreviated id of the commit or null.

Methods inherited from class org.springframework.boot.info.InfoProperties

get, getInstant, iterator, toPropertySource

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

GitProperties

public GitProperties(Properties entries)

Method Details

getBranch

public String getBranch()

Return the name of the branch or null.

Returns:

the branch

getCommitId

public String getCommitId()

Return the full id of the commit or null.

Returns:

the full commit id

getShortCommitId

public String getShortCommitId()

Return the abbreviated id of the commit or null.

Returns:

the short commit id

getCommitTime

public Instant getCommitTime()

Return the timestamp of the commit or null.

If the original value could not be parsed properly, it is still available with the commit.time key.

Returns:

the commit time

See Also:

• InfoProperties.get(String)