com.synerset.unitility.spring.PhysicalQuantityWebMvcConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unitility-spring Show documentation

The Java Physics Units of Measure Library - Unitility, Spring extension. This module integrates unitility-core and unitility-jackson. It provides a preconfigured Jackson module and WebMvcConfigurer for automatic serialization/deserialization of all supported physical quantity types. This configuration is automatically included through Spring's autoconfiguration.

There is a newer version: 2.5.0

Show newest version

package com.synerset.unitility.spring;

import com.synerset.unitility.spring.serialization.PhysicalQuantityWebMvcConverter;
import com.synerset.unitility.unitsystem.util.PhysicalQuantityParsingFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.format.FormatterRegistry;
import org.springframework.lang.NonNull;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * The PhysicalQuantityWebMvcConfiguration class is a Spring Boot autoconfiguration class that configures
 * WebMvcConfigurer to add converters for PhysicalQuantity instances. This mechanism is required for
 * deserializing PhysicalQuantity from PathParams or QueryParams based on parsers registered in
 * {@link PhysicalQuantityParsingFactory}.
 */
@AutoConfiguration
class PhysicalQuantityWebMvcConfiguration implements WebMvcConfigurer {

    private final PhysicalQuantityParsingFactory parsingFactory;
    PhysicalQuantityWebMvcConfiguration(@Qualifier("defaultParsingFactory") PhysicalQuantityParsingFactory parsingFactory) {

        this.parsingFactory = parsingFactory;
    }

    /**
     * Adds converters for PhysicalQuantity instances to the FormatterRegistry.
     * Spring calls this method to add converters for converting strings to PhysicalQuantity instances
     * and vice versa. It uses the {@link PhysicalQuantityWebMvcConverter} for each registered PhysicalQuantity class.
     *
     * @param registry The FormatterRegistry to which converters are added.
     */
    @Override
    public void addFormatters(@NonNull FormatterRegistry registry) {
        parsingFactory.findAllRegisteredClasses()
                .forEach(quantityClass -> registry.addConverter(
                        String.class,
                        quantityClass,
                        new PhysicalQuantityWebMvcConverter<>(quantityClass, parsingFactory))
                );
    }

}