Package org.bson
Class EmptyBSONCallback
- java.lang.Object
-
- org.bson.EmptyBSONCallback
-
- All Implemented Interfaces:
BSONCallback
- Direct Known Subclasses:
LazyBSONCallback
@Deprecated(since="2022-10-31") public class EmptyBSONCallback extends java.lang.Object implements BSONCallback
Deprecated.Usage of this API is not supported in AEM as a Cloud Service.Convenience implementation of BSONCallback that throwsUnsupportedOperationException
for all methods.
-
-
Constructor Summary
Constructors Constructor Description EmptyBSONCallback()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
arrayDone()
Deprecated.Called the end of the array, and returns the completed array.void
arrayStart()
Deprecated.Signals the start of a BSON array.void
arrayStart(java.lang.String name)
Deprecated.Signals the start of a BSON array, with its field name.BSONCallback
createBSONCallback()
Deprecated.Factory method for BSONCallbacks.java.lang.Object
get()
Deprecated.Returns the finished top-level Document.void
gotBinary(java.lang.String name, byte type, byte[] data)
Deprecated.Called when reading a field with aBsonType.BINARY
value.void
gotBinaryArray(java.lang.String name, byte[] data)
Deprecated.void
gotBoolean(java.lang.String name, boolean value)
Deprecated.Called when reading a field with aBsonType.BOOLEAN
value.void
gotCode(java.lang.String name, java.lang.String code)
Deprecated.Called when reading a field with aBsonType.JAVASCRIPT
value.void
gotCodeWScope(java.lang.String name, java.lang.String code, java.lang.Object scope)
Deprecated.Called when reading a field with aBsonType.JAVASCRIPT_WITH_SCOPE
value.void
gotDate(java.lang.String name, long millis)
Deprecated.Called when reading a field with aBsonType.DATE_TIME
value.void
gotDBRef(java.lang.String name, java.lang.String namespace, ObjectId id)
Deprecated.Invoked whenBSONDecoder
encountered aBsonType.DB_POINTER
type field in a byte sequence.void
gotDecimal128(java.lang.String name, Decimal128 value)
Deprecated.Called when reading a field with aBsonType.DECIMAL128
value.void
gotDouble(java.lang.String name, double value)
Deprecated.Called when reading a field with aBsonType.DOUBLE
value.void
gotInt(java.lang.String name, int value)
Deprecated.Called when reading a field with aBsonType.INT32
value.void
gotLong(java.lang.String name, long value)
Deprecated.Called when reading a field with aBsonType.INT64
value.void
gotMaxKey(java.lang.String name)
Deprecated.Called when reading a field with aBsonType.MAX_KEY
value.void
gotMinKey(java.lang.String name)
Deprecated.Called when reading a field with aBsonType.MIN_KEY
value.void
gotNull(java.lang.String name)
Deprecated.Called when reading a BSON field that exists but has a null value.void
gotObjectId(java.lang.String name, ObjectId id)
Deprecated.Called when reading a field with aBsonType.OBJECT_ID
value.void
gotRegex(java.lang.String name, java.lang.String pattern, java.lang.String flags)
Deprecated.Called when reading a field with aBsonType.REGULAR_EXPRESSION
value.void
gotString(java.lang.String name, java.lang.String value)
Deprecated.Called when reading a field with aBsonType.STRING
value.void
gotSymbol(java.lang.String name, java.lang.String value)
Deprecated.Called when reading a field with aBsonType.SYMBOL
value.void
gotTimestamp(java.lang.String name, int time, int increment)
Deprecated.Called when reading a field with aBsonType.TIMESTAMP
value.void
gotUndefined(java.lang.String name)
Deprecated.Called when reading a field with aBsonType.UNDEFINED
value.void
gotUUID(java.lang.String name, long part1, long part2)
Deprecated.Called when reading a field with aUUID
value.java.lang.Object
objectDone()
Deprecated.Called at the end of the document/array, and returns this object.void
objectStart()
Deprecated.Signals the start of a BSON document, which usually maps onto some Java object.void
objectStart(java.lang.String name)
Deprecated.Signals the start of a BSON document, which usually maps onto some Java object.void
reset()
Deprecated.Resets the callback, clearing all state.
-
-
-
Method Detail
-
objectStart
public void objectStart()
Deprecated.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
public void objectStart(java.lang.String name)
Deprecated.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
public java.lang.Object objectDone()
Deprecated.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()
Deprecated.Description copied from interface:BSONCallback
Resets the callback, clearing all state.- Specified by:
reset
in interfaceBSONCallback
-
get
public java.lang.Object get()
Deprecated.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
public BSONCallback createBSONCallback()
Deprecated.Description copied from interface:BSONCallback
Factory method for BSONCallbacks.- Specified by:
createBSONCallback
in interfaceBSONCallback
- Returns:
- a new BSONCallback.
-
arrayStart
public void arrayStart()
Deprecated.Description copied from interface:BSONCallback
Signals the start of a BSON array.- Specified by:
arrayStart
in interfaceBSONCallback
-
arrayStart
public void arrayStart(java.lang.String name)
Deprecated.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
public java.lang.Object arrayDone()
Deprecated.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
public void gotNull(java.lang.String name)
Deprecated.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:
BsonType.NULL
-
gotUndefined
public void gotUndefined(java.lang.String name)
Deprecated.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:
BsonType.UNDEFINED
-
gotMinKey
public void gotMinKey(java.lang.String name)
Deprecated.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
public void gotMaxKey(java.lang.String name)
Deprecated.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
public void gotBoolean(java.lang.String name, boolean value)
Deprecated.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
public void gotDouble(java.lang.String name, double value)
Deprecated.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
public void gotInt(java.lang.String name, int value)
Deprecated.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
public void gotLong(java.lang.String name, long value)
Deprecated.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
public void gotDecimal128(java.lang.String name, Decimal128 value)
Deprecated.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
public void gotDate(java.lang.String name, long millis)
Deprecated.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
public void gotString(java.lang.String name, java.lang.String value)
Deprecated.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
public void gotSymbol(java.lang.String name, java.lang.String value)
Deprecated.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
public void gotRegex(java.lang.String name, java.lang.String pattern, java.lang.String flags)
Deprecated.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
public void gotTimestamp(java.lang.String name, int time, int increment)
Deprecated.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
public void gotObjectId(java.lang.String name, ObjectId id)
Deprecated.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
public void gotDBRef(java.lang.String name, java.lang.String namespace, ObjectId id)
Deprecated.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
-
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 interfaceBSONCallback
- Parameters:
name
- the name of the fielddata
- the field's value
-
gotBinary
public void gotBinary(java.lang.String name, byte type, byte[] data)
Deprecated.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
public void gotUUID(java.lang.String name, long part1, long part2)
Deprecated.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
public void gotCode(java.lang.String name, java.lang.String code)
Deprecated.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
public void gotCodeWScope(java.lang.String name, java.lang.String code, java.lang.Object scope)
Deprecated.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
-
-