Package org.bson
Class EmptyBSONCallback
-
- org.bson.EmptyBSONCallback
-
- All Implemented Interfaces:
BSONCallback
- Direct Known Subclasses:
LazyBSONCallback
public class EmptyBSONCallback extends implements BSONCallback
Convenience implementation of BSONCallback that throwsUnsupportedOperationException
for all methods.
-
-
Constructor Summary
Constructors Constructor Description EmptyBSONCallback()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description arrayDone()
Called the end of the array, and returns the completed array.void
arrayStart()
Signals the start of a BSON array.void
name)
Signals the start of a BSON array, with its field name.BSONCallback
createBSONCallback()
Factory method for BSONCallbacks.get()
Returns the finished top-level Document.void
name, byte type, byte[] data)
Called when reading a field with aBsonType.BINARY
value.void
name, byte[] data)
Deprecated.void
name, boolean value)
Called when reading a field with aBsonType.BOOLEAN
value.void
name, code)
Called when reading a field with aBsonType.JAVASCRIPT
value.void
name, code, scope)
Called when reading a field with aBsonType.JAVASCRIPT_WITH_SCOPE
value.void
name, long millis)
Called when reading a field with aBsonType.DATE_TIME
value.void
name, namespace, ObjectId id)
Invoked whenBSONDecoder
encountered aBsonType.DB_POINTER
type field in a byte sequence.void
name, Decimal128 value)
Called when reading a field with aBsonType.DECIMAL128
value.void
name, double value)
Called when reading a field with aBsonType.DOUBLE
value.void
name, int value)
Called when reading a field with aBsonType.INT32
value.void
name, long value)
Called when reading a field with aBsonType.INT64
value.void
name)
Called when reading a field with aBsonType.MAX_KEY
value.void
name)
Called when reading a field with aBsonType.MIN_KEY
value.void
name)
Called when reading a BSON field that exists but has a null value.void
name, ObjectId id)
Called when reading a field with aBsonType.OBJECT_ID
value.void
name, pattern, flags)
Called when reading a field with aBsonType.REGULAR_EXPRESSION
value.void
name, value)
Called when reading a field with aBsonType.STRING
value.void
name, value)
Called when reading a field with aBsonType.SYMBOL
value.void
name, int time, int increment)
Called when reading a field with aBsonType.TIMESTAMP
value.void
name)
Called when reading a field with aBsonType.UNDEFINED
value.void
name, long part1, long part2)
Called when reading a field with a value.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
name)
Signals the start of a BSON document, which usually maps onto some Java object.void
reset()
Resets the callback, clearing all state.
-
-
-
Method Detail
-
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
public void objectStart( name)
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 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
public 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
public BSONCallback 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
public void arrayStart( name)
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 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
public void gotNull( name)
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( name)
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( name)
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( name)
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( name, boolean value)
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( name, double value)
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( name, int value)
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( name, long value)
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( name, Decimal128 value)
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( name, long millis)
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( name, value)
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( name, value)
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( name, pattern, flags)
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( name, int time, int increment)
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( name, ObjectId id)
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( name, namespace, ObjectId id)
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
public void gotBinaryArray( 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( name, byte type, byte[] data)
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( name, long part1, long part2)
Description copied from interface:BSONCallback
Called when reading a field with a 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( name, code)
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( name, code, scope)
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
-
-