Package org.bson

Interface BSONEncoder

  • All Known Implementing Classes:
    BasicBSONEncoder, DefaultDBEncoder

    @Deprecated(since="2022-10-31")
    public interface BSONEncoder
    Deprecated.
    Usage of this API is not supported in AEM as a Cloud Service.

    A BSONEncoder is a class which can be used to turn documents into byte arrays. The BSONEncoder walks down through the object graph and writes corresponding byte sequences into underlying OutputBuffer.

    This class is a part of legacy API. Please check Encoder for a new one.

    • Method Detail

      • encode

        byte[] encode​(BSONObject document)
        Deprecated.
        Encode a document into byte array. This is a shortcut method which creates a new OutputBuffer, invokes the other 3 methods in a corresponding sequence: and returns the contents of the OutputBuffer.
        Parameters:
        document - the document to be encoded
        Returns:
        a byte sequence
      • putObject

        int putObject​(BSONObject document)
        Deprecated.
        Encoder and write a document into underlying buffer.
        Parameters:
        document - the document to be encoded
        Returns:
        number of bytes written
      • done

        void done()
        Deprecated.
        Free the resources.
      • set

        void set​(OutputBuffer buffer)
        Deprecated.
        Sets the buffer to wrich the result of encoding will be written.
        Parameters:
        buffer - the buffer to be used to write a byte sequences to