Package org.bson
Class EmptyBSONCallback
java.lang.Object
org.bson.EmptyBSONCallback
- All Implemented Interfaces:
BSONCallback
- Direct Known Subclasses:
LazyBSONCallback
Convenience implementation of BSONCallback that throws
UnsupportedOperationException
for all methods.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCalled the end of the array, and returns the completed array.void
Signals the start of a BSON array.void
arrayStart
(String name) Signals the start of a BSON array, with its field name.Factory method for BSONCallbacks.get()
Returns the finished top-level Document.void
Called when reading a field with aBsonType.BINARY
value.void
gotBoolean
(String name, boolean value) Called when reading a field with aBsonType.BOOLEAN
value.void
Called when reading a field with aBsonType.JAVASCRIPT
value.void
gotCodeWScope
(String name, String code, Object scope) Called when reading a field with aBsonType.JAVASCRIPT_WITH_SCOPE
value.void
Called when reading a field with aBsonType.DATE_TIME
value.void
Invoked whenBSONDecoder
encountered aBsonType.DB_POINTER
type field in a byte sequence.void
gotDecimal128
(String name, Decimal128 value) Called when reading a field with aBsonType.DECIMAL128
value.void
Called when reading a field with aBsonType.DOUBLE
value.void
Called when reading a field with aBsonType.INT32
value.void
Called when reading a field with aBsonType.INT64
value.void
Called when reading a field with aBsonType.MAX_KEY
value.void
Called when reading a field with aBsonType.MIN_KEY
value.void
Called when reading a BSON field that exists but has a null value.void
gotObjectId
(String name, ObjectId id) Called when reading a field with aBsonType.OBJECT_ID
value.void
Called when reading a field with aBsonType.REGULAR_EXPRESSION
value.void
Called when reading a field with aBsonType.STRING
value.void
Called when reading a field with aBsonType.SYMBOL
value.void
gotTimestamp
(String name, int time, int increment) Called when reading a field with aBsonType.TIMESTAMP
value.void
gotUndefined
(String name) Called when reading a field with aBsonType.UNDEFINED
value.void
Called when reading a field with aUUID
value.Called at the end of the document/array, and returns this object.void
Signals the start of a BSON document, which usually maps onto some Java object.void
objectStart
(String name) Signals the start of a BSON document, which usually maps onto some Java object.void
reset()
Resets the callback, clearing all state.
-
Constructor Details
-
EmptyBSONCallback
public EmptyBSONCallback()
-
-
Method Details
-
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 interfaceBSONCallback
-
objectStart
Description copied from interface:BSONCallback
Signals the start of a BSON document, which usually maps onto some Java object.- Specified by:
objectStart
in interfaceBSONCallback
- Parameters:
name
- the field name of the document.
-
objectDone
Description copied from interface:BSONCallback
Called at the end of the document/array, and returns this object.- Specified by:
objectDone
in interfaceBSONCallback
- Returns:
- the Object that has been read from this section of the document.
-
reset
public void reset()Description copied from interface:BSONCallback
Resets the callback, clearing all state.- Specified by:
reset
in interfaceBSONCallback
-
get
Description copied from interface:BSONCallback
Returns the finished top-level Document.- Specified by:
get
in interfaceBSONCallback
- Returns:
- the top level document read from the database.
-
createBSONCallback
Description copied from interface:BSONCallback
Factory method for BSONCallbacks.- Specified by:
createBSONCallback
in interfaceBSONCallback
- Returns:
- a new BSONCallback.
-
arrayStart
public void arrayStart()Description copied from interface:BSONCallback
Signals the start of a BSON array.- Specified by:
arrayStart
in interfaceBSONCallback
-
arrayStart
Description copied from interface:BSONCallback
Signals the start of a BSON array, with its field name.- Specified by:
arrayStart
in interfaceBSONCallback
- Parameters:
name
- the name of this array field
-
arrayDone
Description copied from interface:BSONCallback
Called the end of the array, and returns the completed array.- Specified by:
arrayDone
in interfaceBSONCallback
- Returns:
- an Object representing the array that has been read from this section of the document.
-
gotNull
Description copied from interface:BSONCallback
Called when reading a BSON field that exists but has a null value.- Specified by:
gotNull
in interfaceBSONCallback
- Parameters:
name
- the name of the field- See Also:
-
gotUndefined
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.UNDEFINED
value.- Specified by:
gotUndefined
in interfaceBSONCallback
- Parameters:
name
- the name of the field- See Also:
-
gotMinKey
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.MIN_KEY
value.- Specified by:
gotMinKey
in interfaceBSONCallback
- Parameters:
name
- the name of the field
-
gotMaxKey
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.MAX_KEY
value.- Specified by:
gotMaxKey
in interfaceBSONCallback
- Parameters:
name
- the name of the field
-
gotBoolean
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.BOOLEAN
value.- Specified by:
gotBoolean
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotDouble
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.DOUBLE
value.- Specified by:
gotDouble
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotInt
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.INT32
value.- Specified by:
gotInt
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotLong
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.INT64
value.- Specified by:
gotLong
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotDecimal128
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.DECIMAL128
value.- Specified by:
gotDecimal128
in interfaceBSONCallback
- Parameters:
name
- the field namevalue
- the Decimal128 field value
-
gotDate
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.DATE_TIME
value.- Specified by:
gotDate
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldmillis
- the date and time in milliseconds
-
gotString
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.STRING
value.- Specified by:
gotString
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotSymbol
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.SYMBOL
value.- Specified by:
gotSymbol
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldvalue
- the field's value
-
gotRegex
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.REGULAR_EXPRESSION
value.- Specified by:
gotRegex
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldpattern
- the regex patternflags
- the optional flags for the regular expression
-
gotTimestamp
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.TIMESTAMP
value.- Specified by:
gotTimestamp
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldtime
- the time in seconds since epochincrement
- an incrementing ordinal for operations within a given second
-
gotObjectId
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.OBJECT_ID
value.- Specified by:
gotObjectId
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldid
- the object ID
-
gotDBRef
Description copied from interface:BSONCallback
Invoked whenBSONDecoder
encountered aBsonType.DB_POINTER
type field in a byte sequence.- Specified by:
gotDBRef
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldnamespace
- the namespace to which reference is pointing toid
- the if of the object to which reference is pointing to
-
gotBinary
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.BINARY
value. Note that binary values have a subtype, which may determine how the value is processed.- Specified by:
gotBinary
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldtype
- one of the binary subtypes:BsonBinarySubType
data
- the field's value
-
gotUUID
Description copied from interface:BSONCallback
Called when reading a field with aUUID
value. This is a binary value of subtypeBsonBinarySubType.UUID_LEGACY
- Specified by:
gotUUID
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldpart1
- the first part of the UUIDpart2
- the second part of the UUID
-
gotCode
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.JAVASCRIPT
value.- Specified by:
gotCode
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldcode
- the JavaScript code
-
gotCodeWScope
Description copied from interface:BSONCallback
Called when reading a field with aBsonType.JAVASCRIPT_WITH_SCOPE
value.- Specified by:
gotCodeWScope
in interfaceBSONCallback
- Parameters:
name
- the name of the fieldcode
- the JavaScript codescope
- a document representing the scope for the code
-