Package com.powsybl.commons.report

Class AbstractReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

java.lang.Object

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

All Implemented Interfaces:

ReportNodeAdderOrBuilder<T>

Direct Known Subclasses:

ReportNodeChildAdderImpl, ReportNodeRootBuilderImpl

public abstract class AbstractReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>
extends Object
implements ReportNodeAdderOrBuilder<T>

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	key
protected String	messageTemplate
protected final Map<String,TypedValue>	values

Constructor Summary

Constructors

Constructor	Description
AbstractReportNodeAdderOrBuilder()

Method Summary

Modifier and Type	Method	Description
protected abstract T	self()
T	withMessageTemplate(String key, String messageTemplate)	Provide the message template to build the ReportNode with.
T	withSeverity(TypedValue severity)	Provide the TypedValue.SEVERITY typed value associated to ReportConstants.REPORT_SEVERITY_KEY key to build the ReportNode with.
T	withSeverity(String severity)	Provide the String value for the TypedValue.SEVERITY type associated to ReportConstants.REPORT_SEVERITY_KEY key to build the ReportNode with.
T	withTypedValue(String key, boolean value, String type)	Provide one typed boolean value to build the ReportNode with.
T	withTypedValue(String key, double value, String type)	Provide one typed double value to build the ReportNode with.
T	withTypedValue(String key, float value, String type)	Provide one typed float value to build the ReportNode with.
T	withTypedValue(String key, int value, String type)	Provide one typed int value to build the ReportNode with.
T	withTypedValue(String key, long value, String type)	Provide one typed long value to build the ReportNode with.
T	withTypedValue(String key, String value, String type)	Provide one typed string value to build the ReportNode with.
T	withUntypedValue(String key, boolean value)	Provide one untyped boolean value to build the ReportNode with.
T	withUntypedValue(String key, double value)	Provide one untyped double value to build the ReportNode with.
T	withUntypedValue(String key, float value)	Provide one untyped float value to build the ReportNode with.
T	withUntypedValue(String key, int value)	Provide one untyped int value to build the ReportNode with.
T	withUntypedValue(String key, long value)	Provide one untyped long value to build the ReportNode with.
T	withUntypedValue(String key, String value)	Provide one untyped string value to build the ReportNode with.

Methods inherited from class java.lang.Object

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

Field Details

values

protected final Map<String,TypedValue> values

key

protected String key

messageTemplate

protected String messageTemplate

Constructor Details

AbstractReportNodeAdderOrBuilder

public AbstractReportNodeAdderOrBuilder()

Method Details

withMessageTemplate

public T withMessageTemplate(String key,
 String messageTemplate)

Description copied from interface: ReportNodeAdderOrBuilder

Provide the message template to build the ReportNode with.

Specified by:

withMessageTemplate in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key identifying uniquely the message template

messageTemplate - functional log, which may contain references to values using the ${key} syntax, the values mentioned being the values of corresponding ReportNode and the values of any ReportNode ancestor of the created ReportNode

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 String value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed string value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed string value

value - the string value

type - the string representing the type of the string value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 String value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped string value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the string value

value - the string value

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 double value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed double value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed double value

value - the double value

type - the string representing the type of the double value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 double value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped double value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the double value

value - the double value

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 float value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed float value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed float value

value - the float value

type - the string representing the type of the float value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 float value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped float value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the float value

value - the float value

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 int value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed int value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed int value

value - the int value

type - the string representing the type of the int value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 int value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped int value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the int value

value - the int value

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 long value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed long value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed long value

value - the long value

type - the string representing the type of the long value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 long value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped long value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the long value

value - the long value

Returns:

a reference to this object

withTypedValue

public T withTypedValue(String key,
 boolean value,
 String type)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one typed boolean value to build the ReportNode with.

Specified by:

withTypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the typed boolean value

value - the boolean value

type - the string representing the type of the boolean value provided (see TypedValue constants for some generic types)

Returns:

a reference to this object

withUntypedValue

public T withUntypedValue(String key,
 boolean value)

Description copied from interface: ReportNodeAdderOrBuilder

Provide one untyped boolean value to build the ReportNode with.

Specified by:

withUntypedValue in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

key - the key for the boolean value

value - the boolean value

Returns:

a reference to this object

withSeverity

public T withSeverity(TypedValue severity)

Description copied from interface: ReportNodeAdderOrBuilder

Provide the TypedValue.SEVERITY typed value associated to ReportConstants.REPORT_SEVERITY_KEY key to build the ReportNode with.

Specified by:

withSeverity in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

severity - the TypedValue.SEVERITY typed value associated to ReportConstants.REPORT_SEVERITY_KEY key

Returns:

a reference to this object

withSeverity

public T withSeverity(String severity)

Description copied from interface: ReportNodeAdderOrBuilder

Provide the String value for the TypedValue.SEVERITY type associated to ReportConstants.REPORT_SEVERITY_KEY key to build the ReportNode with.

Specified by:

withSeverity in interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>

Parameters:

severity - the String value

Returns:

a reference to this object

self

protected abstract T self()