com.mongodb.DBEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

The newest version!

/*
 * 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.
 */
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);
}