Module com.powsybl.commons

Package com.powsybl.commons.reporter

Class Report

java.lang.Object

com.powsybl.commons.reporter.Report

public class Report
extends Object

A class representing a functional log, consisting of a key identifying the report, a map of TypedValue indexed by their keys, and a default report message string, which may contain references to those values or to the values of corresponding Reporter.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REPORT_SEVERITY_KEY

Constructor Summary

Constructors

Constructor	Description
Report(String reportKey, String defaultMessage, Map<String,TypedValue> values)	Constructor

Method Summary

Modifier and Type	Method	Description
static ReportBuilder	builder()
String	getDefaultMessage()
String	getReportKey()
TypedValue	getValue(String valueKey)
Map<String,TypedValue>	getValues()
static Report	parseJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode, Map<String,String> dictionary, com.fasterxml.jackson.core.ObjectCodec codec)

Methods inherited from class java.lang.Object

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

Field Details

REPORT_SEVERITY_KEY

public static final String REPORT_SEVERITY_KEY

See Also:

• Constant Field Values

Constructor Details

Report

public Report(String reportKey,
 String defaultMessage,
 Map<String,TypedValue> values)

Constructor

Parameters:

reportKey - a key identifying the current report

defaultMessage - the default report message, which may contain references to the provided values or to the values of corresponding Reporter.

values - a map of TypedValue indexed by their key, which may be referred to within the defaultMessage provided

Method Details

builder

public static ReportBuilder builder()

getDefaultMessage

public String getDefaultMessage()

getReportKey

public String getReportKey()

getValue

public TypedValue getValue(String valueKey)

getValues

public Map<String,TypedValue> getValues()

parseJsonNode

public static Report parseJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode,
 Map<String,String> dictionary,
 com.fasterxml.jackson.core.ObjectCodec codec)
                            throws IOException

Throws:

IOException