Package com.mongodb.connection

Class SplittablePayload

java.lang.Object

com.mongodb.connection.SplittablePayload

public final class SplittablePayload
extends Object

A Splittable payload for write commands.

The command will consume as much of the payload as possible. The hasAnotherSplit() method will return true if there is another split to consume, getNextSplit() method will return the next SplittablePayload.

Since:

3.6

See Also:

Connection.command(String, org.bson.BsonDocument, org.bson.FieldNameValidator, com.mongodb.ReadPreference, org.bson.codecs.Decoder, com.mongodb.session.SessionContext, boolean, com.mongodb.connection.SplittablePayload, org.bson.FieldNameValidator), AsyncConnection.commandAsync(String, org.bson.BsonDocument, org.bson.FieldNameValidator, com.mongodb.ReadPreference, org.bson.codecs.Decoder, com.mongodb.session.SessionContext, boolean, com.mongodb.connection.SplittablePayload, org.bson.FieldNameValidator, com.mongodb.async.SingleResultCallback)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SplittablePayload.Type	The type of the payload.

Constructor Summary

Constructors

Constructor	Description
SplittablePayload(SplittablePayload.Type payloadType, List<BsonDocument> payload)	Create a new instance

Method Summary

Modifier and Type	Method	Description
SplittablePayload	getNextSplit()
List<BsonDocument>	getPayload()
String	getPayloadName()
SplittablePayload.Type	getPayloadType()
int	getPosition()
boolean	hasAnotherSplit()
boolean	isEmpty()
void	setPosition(int position)	Sets the current position in the payload

Methods inherited from class java.lang.Object

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

Constructor Detail

SplittablePayload

public SplittablePayload(SplittablePayload.Type payloadType,
                         List<BsonDocument> payload)

Create a new instance

Parameters:

payloadType - the payload type

payload - the payload

Method Detail

getPayloadType

public SplittablePayload.Type getPayloadType()

Returns:

the payload type

getPayloadName

public String getPayloadName()

Returns:

the payload name

getPayload

public List<BsonDocument> getPayload()

Returns:

the payload

getPosition

public int getPosition()

Returns:

the current position in the payload

setPosition

public void setPosition(int position)

Sets the current position in the payload

Parameters:

position - the position

hasAnotherSplit

public boolean hasAnotherSplit()

Returns:

true if there are more values after the current position

getNextSplit

public SplittablePayload getNextSplit()

Returns:

a new SplittablePayload containing only the values after the current position.

isEmpty

public boolean isEmpty()

Returns:

true if the payload is empty