Package com.powsybl.balances_adjustment.balance_computation.json_parameters

Class JsonBalanceComputationParameters

java.lang.Object

com.powsybl.balances_adjustment.balance_computation.json_parameters.JsonBalanceComputationParameters

public final class JsonBalanceComputationParameters
extends Object

Provides methods to read and write BalanceComputationParameters from and to JSON.

Author:

Mohamed Ben Rejeb <mohamed.benrejeb at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonBalanceComputationParameters.ExtensionSerializer<E extends com.powsybl.commons.extensions.Extension<BalanceComputationParameters>>	A configuration loader interface for the LoadFlowParameters extensions loaded from the platform configuration

Method Summary

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

Gets the known extension serializers.

read

public static BalanceComputationParameters read(Path jsonFile)

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

read

public static BalanceComputationParameters read(InputStream jsonStream)

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

update

public static BalanceComputationParameters update(BalanceComputationParameters parameters,
                                                  Path jsonFile)

Updates parameters by reading the content of a JSON file.

update

public static BalanceComputationParameters update(BalanceComputationParameters parameters,
                                                  InputStream jsonStream)

Updates parameters by reading the content of a JSON stream.

write

public static void write(BalanceComputationParameters parameters,
                         Path jsonFile)

Writes parameters as JSON to a file.

write

public static void write(BalanceComputationParameters parameters,
                         OutputStream outputStream)

Writes parameters as JSON to an output stream.

deserialize

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

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

Throws:

IOException

deserialize

public static BalanceComputationParameters 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 balance computation parameters nested in another object.

Throws:

IOException

serialize

public static void serialize(BalanceComputationParameters 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 balance computation parameters nested in another object.

Throws:

IOException