Package com.powsybl.commons.report
Interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>
- All Known Subinterfaces:
ReportNodeAdder
,ReportNodeBuilder
- All Known Implementing Classes:
AbstractReportNodeAdderOrBuilder
,ReportNodeChildAdderImpl
,ReportNodeRootBuilderImpl
public interface ReportNodeAdderOrBuilder<T extends ReportNodeAdderOrBuilder<T>>
-
Method Summary
Modifier and TypeMethodDescriptionwithMessageTemplate
(String key, String messageTemplate) Provide the message template to build theReportNode
with.withSeverity
(TypedValue severity) Provide theTypedValue.SEVERITY
typed value associated toReportConstants.SEVERITY_KEY
key to build theReportNode
with.withSeverity
(String severity) Provide theString
value for theTypedValue.SEVERITY
type associated toReportConstants.SEVERITY_KEY
key to build theReportNode
with.withTypedValue
(String key, boolean value, String type) Provide one typed boolean value to build theReportNode
with.withTypedValue
(String key, double value, String type) Provide one typed double value to build theReportNode
with.withTypedValue
(String key, float value, String type) Provide one typed float value to build theReportNode
with.withTypedValue
(String key, int value, String type) Provide one typed int value to build theReportNode
with.withTypedValue
(String key, long value, String type) Provide one typed long value to build theReportNode
with.withTypedValue
(String key, String value, String type) Provide one typed string value to build theReportNode
with.withUntypedValue
(String key, boolean value) Provide one untyped boolean value to build theReportNode
with.withUntypedValue
(String key, double value) Provide one untyped double value to build theReportNode
with.withUntypedValue
(String key, float value) Provide one untyped float value to build theReportNode
with.withUntypedValue
(String key, int value) Provide one untyped int value to build theReportNode
with.withUntypedValue
(String key, long value) Provide one untyped long value to build theReportNode
with.withUntypedValue
(String key, String value) Provide one untyped string value to build theReportNode
with.
-
Method Details
-
withMessageTemplate
Provide the message template to build theReportNode
with.- Parameters:
key
- the key identifying uniquely the message templatemessageTemplate
- functional log, which may contain references to values using the${key}
syntax, the values mentioned being the values of correspondingReportNode
and the values of anyReportNode
ancestor of the createdReportNode
- Returns:
- a reference to this object
-
withTypedValue
Provide one typed string value to build theReportNode
with.- Parameters:
key
- the key for the typed string valuevalue
- the string valuetype
- the string representing the type of the string value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped string value to build theReportNode
with.- Parameters:
key
- the key for the string valuevalue
- the string value- Returns:
- a reference to this object
-
withTypedValue
Provide one typed double value to build theReportNode
with.- Parameters:
key
- the key for the typed double valuevalue
- the double valuetype
- the string representing the type of the double value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped double value to build theReportNode
with.- Parameters:
key
- the key for the double valuevalue
- the double value- Returns:
- a reference to this object
-
withTypedValue
Provide one typed float value to build theReportNode
with.- Parameters:
key
- the key for the typed float valuevalue
- the float valuetype
- the string representing the type of the float value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped float value to build theReportNode
with.- Parameters:
key
- the key for the float valuevalue
- the float value- Returns:
- a reference to this object
-
withTypedValue
Provide one typed int value to build theReportNode
with.- Parameters:
key
- the key for the typed int valuevalue
- the int valuetype
- the string representing the type of the int value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped int value to build theReportNode
with.- Parameters:
key
- the key for the int valuevalue
- the int value- Returns:
- a reference to this object
-
withTypedValue
Provide one typed long value to build theReportNode
with.- Parameters:
key
- the key for the typed long valuevalue
- the long valuetype
- the string representing the type of the long value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped long value to build theReportNode
with.- Parameters:
key
- the key for the long valuevalue
- the long value- Returns:
- a reference to this object
-
withTypedValue
Provide one typed boolean value to build theReportNode
with.- Parameters:
key
- the key for the typed boolean valuevalue
- the boolean valuetype
- the string representing the type of the boolean value provided (seeTypedValue
constants for some generic types)- Returns:
- a reference to this object
-
withUntypedValue
Provide one untyped boolean value to build theReportNode
with.- Parameters:
key
- the key for the boolean valuevalue
- the boolean value- Returns:
- a reference to this object
-
withSeverity
Provide theTypedValue.SEVERITY
typed value associated toReportConstants.SEVERITY_KEY
key to build theReportNode
with.- Parameters:
severity
- theTypedValue.SEVERITY
typed value associated toReportConstants.SEVERITY_KEY
key- Returns:
- a reference to this object
-
withSeverity
Provide theString
value for theTypedValue.SEVERITY
type associated toReportConstants.SEVERITY_KEY
key to build theReportNode
with.- Parameters:
severity
- theString
value- Returns:
- a reference to this object
-