Package org.bson

Class BasicBSONCallback

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicBSONCallback()
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object arrayDone()
      Called the end of the array, and returns the completed array.
      void arrayStart()
      Signals the start of a BSON array.
      void arrayStart​(java.lang.String name)
      Signals the start of a BSON array, with its field name.
      BSONObject create()
      Factory method for creating a new BSONObject.
      BSONObject create​(boolean array, java.util.List<java.lang.String> path)
      Helper method to create either a BSON Object or a BSON List depending upon whether the array parameter is true or not.
      BSONCallback createBSONCallback()
      Factory method for BSONCallbacks.
      java.lang.Object get()
      Returns the finished top-level Document.
      void gotBinary​(java.lang.String name, byte type, byte[] data)
      Called when reading a field with a BsonType.BINARY value.
      void gotBinaryArray​(java.lang.String name, byte[] data)
      Deprecated.
      void gotBoolean​(java.lang.String name, boolean value)
      Called when reading a field with a BsonType.BOOLEAN value.
      void gotCode​(java.lang.String name, java.lang.String code)
      Called when reading a field with a BsonType.JAVASCRIPT value.
      void gotCodeWScope​(java.lang.String name, java.lang.String code, java.lang.Object scope)
      Called when reading a field with a BsonType.JAVASCRIPT_WITH_SCOPE value.
      void gotDate​(java.lang.String name, long millis)
      Called when reading a field with a BsonType.DATE_TIME value.
      void gotDBRef​(java.lang.String name, java.lang.String namespace, ObjectId id)
      Invoked when BSONDecoder encountered a BsonType.DB_POINTER type field in a byte sequence.
      void gotDecimal128​(java.lang.String name, Decimal128 value)
      Called when reading a field with a BsonType.DECIMAL128 value.
      void gotDouble​(java.lang.String name, double value)
      Called when reading a field with a BsonType.DOUBLE value.
      void gotInt​(java.lang.String name, int value)
      Called when reading a field with a BsonType.INT32 value.
      void gotLong​(java.lang.String name, long value)
      Called when reading a field with a BsonType.INT64 value.
      void gotMaxKey​(java.lang.String name)
      Called when reading a field with a BsonType.MAX_KEY value.
      void gotMinKey​(java.lang.String name)
      Called when reading a field with a BsonType.MIN_KEY value.
      void gotNull​(java.lang.String name)
      Called when reading a BSON field that exists but has a null value.
      void gotObjectId​(java.lang.String name, ObjectId id)
      Called when reading a field with a BsonType.OBJECT_ID value.
      void gotRegex​(java.lang.String name, java.lang.String pattern, java.lang.String flags)
      Called when reading a field with a BsonType.REGULAR_EXPRESSION value.
      void gotString​(java.lang.String name, java.lang.String value)
      Called when reading a field with a BsonType.STRING value.
      void gotSymbol​(java.lang.String name, java.lang.String value)
      Called when reading a field with a BsonType.SYMBOL value.
      void gotTimestamp​(java.lang.String name, int time, int increment)
      Called when reading a field with a BsonType.TIMESTAMP value.
      void gotUndefined​(java.lang.String name)
      Called when reading a field with a BsonType.UNDEFINED value.
      void gotUUID​(java.lang.String name, long part1, long part2)
      Called when reading a field with a UUID value.
      java.lang.Object objectDone()
      Called at the end of the document/array, and returns this object.
      void objectStart()
      Signals the start of a BSON document, which usually maps onto some Java object.
      void objectStart​(java.lang.String name)
      Signals the start of a BSON document, which usually maps onto some Java object.
      void reset()
      Resets the callback, clearing all state.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BasicBSONCallback

        public BasicBSONCallback()
        Creates a new instance.

    • Method Detail

      • get

        public java.lang.Object get()
        Description copied from interface: BSONCallback
        Returns the finished top-level Document.
        Specified by:
        get in interface BSONCallback
        Returns:
        the top level document read from the database.

      • create

        public BSONObject create()
        Factory method for creating a new BSONObject.
        Returns:
        a new BasicBSONObject.

      • create

        public BSONObject create​(boolean array,
                         java.util.List<java.lang.String> path)
        Helper method to create either a BSON Object or a BSON List depending upon whether the array parameter is true or not.
        Parameters:
        array - set to true to create a new BSON List, otherwise will create a new BSONObject
        path - a list of field names to navigate to this field in the document
        Returns:
        the new BSONObject

      • objectStart

        public void objectStart()
        Description copied from interface: BSONCallback
        Signals the start of a BSON document, which usually maps onto some Java object.
        Specified by:
        objectStart in interface BSONCallback

      • objectStart

        public void objectStart​(java.lang.String name)
        Description copied from interface: BSONCallback
        Signals the start of a BSON document, which usually maps onto some Java object.
        Specified by:
        objectStart in interface BSONCallback
        Parameters:
        name - the field name of the document.

      • objectDone

        public java.lang.Object objectDone()
        Description copied from interface: BSONCallback
        Called at the end of the document/array, and returns this object.
        Specified by:
        objectDone in interface BSONCallback
        Returns:
        the Object that has been read from this section of the document.

      • arrayStart

        public void arrayStart()
        Description copied from interface: BSONCallback
        Signals the start of a BSON array.
        Specified by:
        arrayStart in interface BSONCallback

      • arrayStart

        public void arrayStart​(java.lang.String name)
        Description copied from interface: BSONCallback
        Signals the start of a BSON array, with its field name.
        Specified by:
        arrayStart in interface BSONCallback
        Parameters:
        name - the name of this array field

      • arrayDone

        public java.lang.Object arrayDone()
        Description copied from interface: BSONCallback
        Called the end of the array, and returns the completed array.
        Specified by:
        arrayDone in interface BSONCallback
        Returns:
        an Object representing the array that has been read from this section of the document.

      • gotNull

        public void gotNull​(java.lang.String name)
        Description copied from interface: BSONCallback
        Called when reading a BSON field that exists but has a null value.
        Specified by:
        gotNull in interface BSONCallback
        Parameters:
        name - the name of the field
        See Also:
        BsonType.NULL

      • gotMinKey

        public void gotMinKey​(java.lang.String name)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.MIN_KEY value.
        Specified by:
        gotMinKey in interface BSONCallback
        Parameters:
        name - the name of the field

      • gotMaxKey

        public void gotMaxKey​(java.lang.String name)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.MAX_KEY value.
        Specified by:
        gotMaxKey in interface BSONCallback
        Parameters:
        name - the name of the field

      • gotBoolean

        public void gotBoolean​(java.lang.String name,
                       boolean value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.BOOLEAN value.
        Specified by:
        gotBoolean in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotDouble

        public void gotDouble​(java.lang.String name,
                      double value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.DOUBLE value.
        Specified by:
        gotDouble in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotInt

        public void gotInt​(java.lang.String name,
                   int value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.INT32 value.
        Specified by:
        gotInt in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotLong

        public void gotLong​(java.lang.String name,
                    long value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.INT64 value.
        Specified by:
        gotLong in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotDate

        public void gotDate​(java.lang.String name,
                    long millis)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.DATE_TIME value.
        Specified by:
        gotDate in interface BSONCallback
        Parameters:
        name - the name of the field
        millis - the date and time in milliseconds

      • gotRegex

        public void gotRegex​(java.lang.String name,
                     java.lang.String pattern,
                     java.lang.String flags)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.REGULAR_EXPRESSION value.
        Specified by:
        gotRegex in interface BSONCallback
        Parameters:
        name - the name of the field
        pattern - the regex pattern
        flags - the optional flags for the regular expression

      • gotString

        public void gotString​(java.lang.String name,
                      java.lang.String value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.STRING value.
        Specified by:
        gotString in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotSymbol

        public void gotSymbol​(java.lang.String name,
                      java.lang.String value)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.SYMBOL value.
        Specified by:
        gotSymbol in interface BSONCallback
        Parameters:
        name - the name of the field
        value - the field's value

      • gotTimestamp

        public void gotTimestamp​(java.lang.String name,
                         int time,
                         int increment)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.TIMESTAMP value.
        Specified by:
        gotTimestamp in interface BSONCallback
        Parameters:
        name - the name of the field
        time - the time in seconds since epoch
        increment - an incrementing ordinal for operations within a given second

      • gotDBRef

        public void gotDBRef​(java.lang.String name,
                     java.lang.String namespace,
                     ObjectId id)
        Description copied from interface: BSONCallback
        Invoked when BSONDecoder encountered a BsonType.DB_POINTER type field in a byte sequence.
        Specified by:
        gotDBRef in interface BSONCallback
        Parameters:
        name - the name of the field
        namespace - the namespace to which reference is pointing to
        id - the if of the object to which reference is pointing to

      • gotBinaryArray

        @Deprecated
public void gotBinaryArray​(java.lang.String name,
                           byte[] data)
        Deprecated.
        Description copied from interface: BSONCallback
        This method is not used.
        Specified by:
        gotBinaryArray in interface BSONCallback
        Parameters:
        name - the name of the field
        data - the field's value

      • gotBinary

        public void gotBinary​(java.lang.String name,
                      byte type,
                      byte[] data)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.BINARY value. Note that binary values have a subtype, which may determine how the value is processed.
        Specified by:
        gotBinary in interface BSONCallback
        Parameters:
        name - the name of the field
        type - one of the binary subtypes: BsonBinarySubType
        data - the field's value

      • gotUUID

        public void gotUUID​(java.lang.String name,
                    long part1,
                    long part2)
        Description copied from interface: BSONCallback
        Called when reading a field with a UUID value. This is a binary value of subtype BsonBinarySubType.UUID_LEGACY
        Specified by:
        gotUUID in interface BSONCallback
        Parameters:
        name - the name of the field
        part1 - the first part of the UUID
        part2 - the second part of the UUID

      • gotCode

        public void gotCode​(java.lang.String name,
                    java.lang.String code)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.JAVASCRIPT value.
        Specified by:
        gotCode in interface BSONCallback
        Parameters:
        name - the name of the field
        code - the JavaScript code

      • gotCodeWScope

        public void gotCodeWScope​(java.lang.String name,
                          java.lang.String code,
                          java.lang.Object scope)
        Description copied from interface: BSONCallback
        Called when reading a field with a BsonType.JAVASCRIPT_WITH_SCOPE value.
        Specified by:
        gotCodeWScope in interface BSONCallback
        Parameters:
        name - the name of the field
        code - the JavaScript code
        scope - a document representing the scope for the code

      • reset

        public void reset()
        Description copied from interface: BSONCallback
        Resets the callback, clearing all state.
        Specified by:
        reset in interface BSONCallback