com.ibm.cloud.objectstorage.protocol.json.StructuredJsonMarshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ibm-cos-java-sdk-bundle Show documentation

A single bundled dependency that includes all service and dependent JARs with third-party libraries relocated to different namespaces.

There is a newer version: 2.14.0

Show newest version

/*
 * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package com.ibm.cloud.objectstorage.protocol.json;

import com.ibm.cloud.objectstorage.annotation.SdkProtectedApi;

/**
 * Interface to marshall an object to the JSON payload using a {@link StructuredJsonGenerator}.
 *
 * @param  Type of object to marshall.
 */
@SdkProtectedApi
public interface StructuredJsonMarshaller {

    /**
     * Marshalls the value using the {@link StructuredJsonGenerator}.
     *
     * @param val           Object to marshall.
     * @param jsonGenerator {@link StructuredJsonGenerator} with methods to write various types to the JSON document.
     */
    void marshall(T val, StructuredJsonGenerator jsonGenerator);
}