Package org.rumbledb.config

Class SerializationParameterBuilder

java.lang.Object

org.rumbledb.config.SerializationParameterBuilder

public final class SerializationParameterBuilder
extends Object

Builder class for constructing and updating SerializationParameters from string parameters. Handles parsing and validation of serialization parameter values according to the XQuery 3.1 Serialization Parameters specification.

Method Summary

Modifier and Type	Method	Description
static SerializationParameters	build(Map<String,String> parameters)	Builds a fresh SerializationParameters instance from the provided parameters.
static SerializationParameters	build(Map<String,String> parameters, SerializationParameters defaults)	Builds a SerializationParameters instance by copying an existing template and applying overrides.
static void	update(SerializationParameters params, String optionName, String optionValue)	Updates a SerializationParameters instance in place with the provided parameter name and value.

Methods inherited from class java.lang.Object

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

Method Details

build

public static SerializationParameters build(Map<String,String> parameters)

Builds a fresh SerializationParameters instance from the provided parameters. This is equivalent to calling build(Map, SerializationParameters) with SerializationParameters.defaults(). All parameter values are validated and an InvalidSerializationParameterValueException is thrown for invalid inputs.

Parameters:

parameters - the raw parameter map (name → value) to apply

Returns:

a configured SerializationParameters instance

Throws:

InvalidSerializationParameterValueException - if any parameter value is invalid

build

public static SerializationParameters build(Map<String,String> parameters,
 SerializationParameters defaults)

Builds a SerializationParameters instance by copying an existing template and applying overrides. A defensive copy of defaults is created so that the original instance is never mutated. Each provided entry is applied via update(SerializationParameters, String, String), guaranteeing consistent validation.

Parameters:

parameters - the override map (name → value) to apply

defaults - the template to inherit unspecified parameters from

Returns:

a configured SerializationParameters instance

Throws:

InvalidSerializationParameterValueException - if any parameter value is invalid

update

public static void update(SerializationParameters params,
 String optionName,
 String optionValue)
                   throws InvalidSerializationParameterValueException

Updates a SerializationParameters instance in place with the provided parameter name and value. Each update is validated; unknown parameter names are forwarded to sparkOptions.

Parameters:

params - the SerializationParameters instance to mutate (typically a local copy)

optionName - the name of the parameter to update

optionValue - the value of the parameter to update

Throws:

InvalidSerializationParameterValueException - if the parameter value is invalid