Package com.powsybl.commons.report

Class ReportNodeRootBuilderImpl

java.lang.Object

com.powsybl.commons.report.AbstractReportNodeAdderOrBuilder<ReportNodeBuilder>

com.powsybl.commons.report.ReportNodeRootBuilderImpl

All Implemented Interfaces:

ReportNodeAdderOrBuilder<ReportNodeBuilder>, ReportNodeBuilder

public class ReportNodeRootBuilderImpl
extends AbstractReportNodeAdderOrBuilder<ReportNodeBuilder>
implements ReportNodeBuilder

A builder to create a root ReportNode object.

Author:

Florian Dupuy <florian.dupuy at rte-france.com>

Field Summary

Fields inherited from class com.powsybl.commons.report.AbstractReportNodeAdderOrBuilder

key, messageTemplate, values

Constructor Summary

Constructors

Constructor	Description
ReportNodeRootBuilderImpl()

Method Summary

Modifier and Type	Method	Description
ReportNode	build()	Build the corresponding ReportNode.
ReportNodeBuilder	self()
ReportNodeBuilder	withTimestampPattern(String timestampPattern, Locale locale)	Sets the pattern and the locale used for formatting timestamps (see DateTimeFormatter.ofPattern(String, Locale)}), if timestamps are enabled.
ReportNodeBuilder	withTimestamps(boolean enabled)	Enable timestamps on build ReportNode and all descendants.

Methods inherited from class com.powsybl.commons.report.AbstractReportNodeAdderOrBuilder

withMessageTemplate, withSeverity, withSeverity, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.commons.report.ReportNodeAdderOrBuilder

withMessageTemplate, withSeverity, withSeverity, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withTypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue, withUntypedValue

Methods inherited from interface com.powsybl.commons.report.ReportNodeBuilder

withTimestampPattern

Constructor Details

ReportNodeRootBuilderImpl

public ReportNodeRootBuilderImpl()

Method Details

withTimestampPattern

public ReportNodeBuilder withTimestampPattern(String timestampPattern,
 Locale locale)

Description copied from interface: ReportNodeBuilder

Sets the pattern and the locale used for formatting timestamps (see DateTimeFormatter.ofPattern(String, Locale)}), if timestamps are enabled. If no pattern and locale are given, the default pattern ReportConstants.DEFAULT_TIMESTAMP_PATTERN and locale ReportConstants.DEFAULT_TIMESTAMP_LOCALE are used.

Specified by:

withTimestampPattern in interface ReportNodeBuilder

Parameters:

timestampPattern - : the pattern to use for the timestamp

locale - the locale to use for formatting the timestamp

Returns:

a reference to this object

withTimestamps

public ReportNodeBuilder withTimestamps(boolean enabled)

Description copied from interface: ReportNodeBuilder

Enable timestamps on build ReportNode and all descendants.

Specified by:

withTimestamps in interface ReportNodeBuilder

Returns:

a reference to this object

build

public ReportNode build()

Description copied from interface: ReportNodeBuilder

Build the corresponding ReportNode.

Specified by:

build in interface ReportNodeBuilder

Returns:

the new ReportNode corresponding to current ReportNodeBuilder

self

public ReportNodeBuilder self()

Specified by:

self in class AbstractReportNodeAdderOrBuilder<ReportNodeBuilder>