com.synerset.unitility.spring.PhysicalQuantityJacksonConfiguration 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.fasterxml.jackson.databind.ObjectMapper;
import com.synerset.unitility.jackson.module.PhysicalQuantityJacksonModule;
import com.synerset.unitility.unitsystem.PhysicalQuantity;
import com.synerset.unitility.unitsystem.util.PhysicalQuantityParsingFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;

/**
 * The PhysicalQuantityJacksonConfiguration class is a Spring Boot autoconfiguration class that customizes the
 * Jackson {@link ObjectMapper} configuration for handling {@link PhysicalQuantity} instances. This is required to allow object
 * mapper to serialize / deserialize PhysicalQuantities in Request and Response objects.
 */
@AutoConfiguration
class PhysicalQuantityJacksonConfiguration {

    /**
     * Creates a {@link Jackson2ObjectMapperBuilderCustomizer} that registers the {@link PhysicalQuantityJacksonModule}.
     * This bean is responsible for customizing the Jackson {@link ObjectMapper} by adding the
     * {@link PhysicalQuantityJacksonModule} to the module registry.
     *
     * @param parsingFactory The {@link PhysicalQuantityJacksonModule} used to create the {@link PhysicalQuantityJacksonModule}.
     * @return A {@link Jackson2ObjectMapperBuilderCustomizer}.
     */
    @Bean
    Jackson2ObjectMapperBuilderCustomizer createPhysicalQuantityJacksonModule(@Qualifier("defaultParsingFactory") PhysicalQuantityParsingFactory parsingFactory) {

        return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.modules(
                new PhysicalQuantityJacksonModule(parsingFactory)
        );
    }

    /**
     * Creates a default {@link PhysicalQuantityParsingFactory} bean.
     * This bean is responsible for creating and providing a default {@link PhysicalQuantityParsingFactory} instance.
     *
     * @return A default {@link PhysicalQuantityParsingFactory}.
     */
    @Bean
    PhysicalQuantityParsingFactory defaultParsingFactory() {
        return PhysicalQuantityParsingFactory.getDefaultParsingFactory();
    }

    @Bean
    PhysicalQuantityParsingFactory geoParsingFactory() {
        return PhysicalQuantityParsingFactory.getDefaultParsingFactory();
    }

}