Package org.springframework.modulith.moments.support

Class MomentsProperties

java.lang.Object

org.springframework.modulith.moments.support.MomentsProperties

@ConfigurationProperties(prefix="spring.modulith.moments")
public class MomentsProperties
extends Object

Configuration properties for Moments.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	MomentsProperties.Granularity	The granularity of events to publish.

Field Summary

Fields

Modifier and Type	Field	Description
static final MomentsProperties	DEFAULTS

Method Summary

Modifier and Type	Method	Description
Locale	getLocale()	The Locale to use when determining week boundaries.
ShiftedQuarter	getShiftedQuarter(LocalDate reference)	Returns the ShiftedQuarter for the given reference date.
ZoneId	getZoneId()	The ZoneId to determine times which are attached to the events published.
boolean	isEnableTimeMachine()	Whether to enable the TimeMachine.
(package private) boolean	isHourly()	Returns whether to create hourly events.
(package private) MomentsProperties	withGranularity(MomentsProperties.Granularity granularity)
(package private) MomentsProperties	withLocale(Locale locale)
(package private) MomentsProperties	withZoneId(ZoneId zoneId)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULTS

public static final MomentsProperties DEFAULTS

Method Details

getZoneId

public ZoneId getZoneId()

The ZoneId to determine times which are attached to the events published. Defaults to ZoneOffset.UTC.

Returns:

will never be null.

getLocale

public Locale getLocale()

The Locale to use when determining week boundaries. Defaults to Locale.getDefault().

Returns:

will never be null.

isEnableTimeMachine

public boolean isEnableTimeMachine()

Whether to enable the TimeMachine.

isHourly

boolean isHourly()

Returns whether to create hourly events.

getShiftedQuarter

public ShiftedQuarter getShiftedQuarter(LocalDate reference)

Returns the ShiftedQuarter for the given reference date.

Parameters:

reference - must not be null.

Returns:

will never be null.

withGranularity

MomentsProperties withGranularity(MomentsProperties.Granularity granularity)

withZoneId

MomentsProperties withZoneId(ZoneId zoneId)

withLocale

MomentsProperties withLocale(Locale locale)