Package com.powsybl.sensitivity.json

Class JsonSensitivityAnalysisParameters

java.lang.Object

com.powsybl.sensitivity.json.JsonSensitivityAnalysisParameters

public final class JsonSensitivityAnalysisParameters
extends Object

Provides methods to read and write sensitivity analysis parameters from and to JSON.

Author:

Sebastien Murgey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonSensitivityAnalysisParameters.ExtensionSerializer<E extends Extension<SensitivityAnalysisParameters>>	A configuration loader interface for the SensitivityAnalysisParameters extensions loaded from the platform configuration

Method Summary

Modifier and Type	Method	Description
static SensitivityAnalysisParameters	deserialize(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext context)	Low level deserialization method, to be used for instance for updating sensitivity analysis parameters nested in another object.
static SensitivityAnalysisParameters	deserialize(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext context, SensitivityAnalysisParameters parameters)	Low level deserialization method, to be used for instance for reading sensitivity analysis parameters nested in another object.
static ExtensionProviders<JsonSensitivityAnalysisParameters.ExtensionSerializer>	getExtensionSerializers()	Gets the known extension serializers.
static SensitivityAnalysisParameters	read(InputStream jsonStream)	Reads parameters from a JSON file (will NOT rely on platform config).
static SensitivityAnalysisParameters	read(Path jsonFile)	Reads parameters from a JSON file (will NOT rely on platform config).
static void	serialize(SensitivityAnalysisParameters parameters, com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider)	Low level serialization method, to be used for instance for writing sensitivity analysis parameters nested in another object.
static SensitivityAnalysisParameters	update(SensitivityAnalysisParameters parameters, InputStream jsonStream)	Updates parameters by reading the content of a JSON stream.
static SensitivityAnalysisParameters	update(SensitivityAnalysisParameters parameters, Path jsonFile)	Updates parameters by reading the content of a JSON file.
static void	write(SensitivityAnalysisParameters parameters, OutputStream outputStream)	Writes parameters as JSON to an output stream.
static void	write(SensitivityAnalysisParameters parameters, Path jsonFile)	Writes parameters as JSON to a file.

Methods inherited from class java.lang.Object

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

Method Detail

getExtensionSerializers

public static ExtensionProviders<JsonSensitivityAnalysisParameters.ExtensionSerializer> getExtensionSerializers()

Gets the known extension serializers.

read

public static SensitivityAnalysisParameters read(Path jsonFile)

Reads parameters from a JSON file (will NOT rely on platform config).

read

public static SensitivityAnalysisParameters read(InputStream jsonStream)

Reads parameters from a JSON file (will NOT rely on platform config).

update

public static SensitivityAnalysisParameters update(SensitivityAnalysisParameters parameters,
                                                   Path jsonFile)

Updates parameters by reading the content of a JSON file.

update

public static SensitivityAnalysisParameters update(SensitivityAnalysisParameters parameters,
                                                   InputStream jsonStream)

Updates parameters by reading the content of a JSON stream.

write

public static void write(SensitivityAnalysisParameters parameters,
                         Path jsonFile)

Writes parameters as JSON to a file.

write

public static void write(SensitivityAnalysisParameters parameters,
                         OutputStream outputStream)

Writes parameters as JSON to an output stream.

deserialize

public static SensitivityAnalysisParameters deserialize(com.fasterxml.jackson.core.JsonParser parser,
                                                        com.fasterxml.jackson.databind.DeserializationContext context,
                                                        SensitivityAnalysisParameters parameters)
                                                 throws IOException

Low level deserialization method, to be used for instance for reading sensitivity analysis parameters nested in another object.

Throws:

IOException

deserialize

public static SensitivityAnalysisParameters deserialize(com.fasterxml.jackson.core.JsonParser parser,
                                                        com.fasterxml.jackson.databind.DeserializationContext context)
                                                 throws IOException

Low level deserialization method, to be used for instance for updating sensitivity analysis parameters nested in another object.

Throws:

IOException

serialize

public static void serialize(SensitivityAnalysisParameters parameters,
                             com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                             com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
                      throws IOException

Low level serialization method, to be used for instance for writing sensitivity analysis parameters nested in another object.

Throws:

IOException