public class Delete extends AbstractMessage
struct {
MsgHeader header; // standard message header
int32 ZERO; // 0 - reserved for future use
cstring fullCollectionName; // "dbname.collectionname"
int32 flags; // bit vector - see below for details.
document selector; // query object. See below for details.
}
Modifier and Type | Field and Description |
---|---|
static int |
SINGLE_DELETE_BIT
The flag bit for performing a single delete only.
|
HEADER_SIZE, myCollectionName, myDatabaseName
Constructor and Description |
---|
Delete(BsonInputStream in)
Create a new Delete message.
|
Delete(String databaseName,
String collectionName,
Document query,
boolean singleDelete)
Create a new Delete message.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object)
Determines if the passed object is of this same type as this object and
if so that its fields are equal.
|
Document |
getQuery()
Returns the query
Document . |
int |
hashCode()
Computes a reasonable hash code.
|
boolean |
isSingleDelete()
Returns if only a single or all matching documents should be deleted.
|
void |
write(int messageId,
BsonOutputStream out)
Writes the message from the stream.
|
getCollectionName, getDatabaseName, getReadPreference, init, writeHeader
public static final int SINGLE_DELETE_BIT
public Delete(BsonInputStream in) throws IOException
in
- The stream to read the delete message from.IOException
- On a failure reading the delete message.public Delete(String databaseName, String collectionName, Document query, boolean singleDelete)
databaseName
- The name of the database.collectionName
- The name of the collection.query
- The query document for selecting documents to delete.singleDelete
- If true, only the first document found should be deleted,
otherwise all matching documents should be deleted.public boolean equals(Object object)
equals
in class AbstractMessage
object
- The object to compare to.Object.equals(java.lang.Object)
public int hashCode()
hashCode
in class AbstractMessage
public boolean isSingleDelete()
public void write(int messageId, BsonOutputStream out) throws IOException
Overridden to write a delete message.
messageId
- The id to be assigned to the message.out
- The sink for data written.IOException
- On an error writing to the stream.Message.write(int, com.allanbank.mongodb.bson.io.BsonOutputStream)
Copyright © 2011-2012 Allanbank Consulting, Inc.. All Rights Reserved.