com.mongodb.DBEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18598.20241113T125352Z-241000

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.mongodb;

import org.bson.BSONObject;
import org.bson.io.OutputBuffer;

/**
 *  An interface for encoders of BSONObject to BSON.
 *
 * @deprecated Usage of this API is not supported in AEM as a Cloud Service.
 */
@Deprecated(since = "2021-05-27")
public interface DBEncoder {

    /**
     * Encode the BSONObject.
     *
     * @param outputBuffer the OutputBuffer to write to
     * @param document     the BSONObject to write
     * @return the number of characters in the encoding
     */
    int writeObject(OutputBuffer outputBuffer, BSONObject document);
}