Class InfoProperties

java.lang.Object

org.springframework.boot.info.InfoProperties

All Implemented Interfaces:

Iterable<InfoProperties.Entry>

Direct Known Subclasses:

BuildProperties, GitProperties

public class InfoProperties
extends Object
implements Iterable<InfoProperties.Entry>

Base class for components exposing unstructured data with dedicated methods for well known keys.

Since:

1.4.0

Author:

Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InfoProperties.Entry	Property entry.

Constructor Summary

Constructors

Constructor	Description
InfoProperties(Properties entries)	Create an instance with the specified entries.

Method Summary

Modifier and Type	Method	Description
@Nullable String	get(String key)	Return the value of the specified property or null.
@Nullable Instant	getInstant(String key)	Return the value of the specified property as an Instant or null if the value is not a valid Long representation of an epoch time.
Iterator<InfoProperties.Entry>	iterator()
PropertySource<?>	toPropertySource()	Return a PropertySource of this instance.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

InfoProperties

public InfoProperties(Properties entries)

Create an instance with the specified entries.

Parameters:

entries - the information to expose

Method Details

get

public @Nullable String get(String key)

Return the value of the specified property or null.

Parameters:

key - the key of the property

Returns:

the property value

getInstant

public @Nullable Instant getInstant(String key)

Return the value of the specified property as an Instant or null if the value is not a valid Long representation of an epoch time.

Parameters:

key - the key of the property

Returns:

the property value

iterator

public Iterator<InfoProperties.Entry> iterator()

Specified by:

iterator in interface Iterable<InfoProperties.Entry>

toPropertySource

public PropertySource<?> toPropertySource()

Return a PropertySource of this instance.

Returns:

a PropertySource