com.azure.core.models.JsonPatchDocumentSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core Show documentation

This package contains core types for Azure Java clients.

There is a newer version: 1.54.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.models;

import com.azure.core.util.CoreUtils;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.module.SimpleModule;

import java.io.IOException;
import java.util.List;

/**
 * Handles the serialization of a {@link JsonPatchDocument}.
 *
 * This class is responsible for converting a {@link JsonPatchDocument} into a JSON representation. It extends the
 * {@link JsonSerializer} class from the Jackson library and overrides the
 * {@link #serialize(JsonPatchDocument, JsonGenerator, SerializerProvider)} method to perform the serialization.
 *
 * This class is useful when you want to serialize a {@link JsonPatchDocument} to JSON. For example, you can use
 * it when you want to send a JSON Patch document as part of an HTTP request.
 *
 * @see JsonPatchDocument
 * @see JsonSerializer
 * @see JsonGenerator
 * @see SerializerProvider
 * @see SimpleModule
 */
final class JsonPatchDocumentSerializer extends JsonSerializer {
    private static final SimpleModule MODULE;

    static {
        MODULE = new SimpleModule().addSerializer(JsonPatchDocument.class, new JsonPatchDocumentSerializer());
    }

    /**
     * Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.
     *
     * @return a simple module to be plugged onto Jackson ObjectMapper.
     */
    public static SimpleModule getModule() {
        return MODULE;
    }

    @Override
    public void serialize(JsonPatchDocument value, JsonGenerator gen, SerializerProvider serializers)
        throws IOException {
        List operations = value.getOperations();
        if (CoreUtils.isNullOrEmpty(operations)) {
            return;
        }

        gen.writeStartArray();

        for (JsonPatchOperation operation : operations) {
            gen.writeObject(operation);
        }

        gen.writeEndArray();
    }
}