Package com.mongodb.client.model

Class PushOptions

java.lang.Object

com.mongodb.client.model.PushOptions

public class PushOptions
extends Object

The options to apply to a $push update operator.

Since:

3.1

See Also:

Updates.pushEach(String, java.util.List, PushOptions)

MongoDB documentation

$push

Constructor Summary

Constructors

Constructor	Description
PushOptions()

Method Summary

Modifier and Type	Method	Description
Integer	getPosition()	Gets the position at which to add the pushed values in the array.
Integer	getSlice()	Gets the slice value, which is the limit on the number of array elements allowed.
Integer	getSort()	Gets the sort direction for sorting array elements that are not documents.
Bson	getSortDocument()	Gets the sort direction for sorting array elements that are documents.
PushOptions	position(Integer position)	Sets the position at which to add the pushed values in the array.
PushOptions	slice(Integer slice)	Sets the limit on the number of array elements allowed.
PushOptions	sort(Integer sort)	Sets the sort direction for sorting array elements that are not documents.
PushOptions	sortDocument(Bson sortDocument)	Sets the sort direction for sorting array elements that are documents.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PushOptions

public PushOptions()

Method Detail

getPosition

@Nullable
public Integer getPosition()

Gets the position at which to add the pushed values in the array.

Returns:

the position, which may be null

MongoDB documentation

$position

position

public PushOptions position(@Nullable
                            Integer position)

Sets the position at which to add the pushed values in the array.

Parameters:

position - the position

Returns:

this

MongoDB documentation

$position

getSlice

@Nullable
public Integer getSlice()

Gets the slice value, which is the limit on the number of array elements allowed.

Returns:

the slice value representing the limit on the number of array elements allowed

MongoDB documentation

$slice

slice

public PushOptions slice(@Nullable
                         Integer slice)

Sets the limit on the number of array elements allowed.

Parameters:

slice - the limit

Returns:

this

MongoDB documentation

$slice

getSort

@Nullable
public Integer getSort()

Gets the sort direction for sorting array elements that are not documents.

Returns:

the sort direction

MongoDB documentation

$sort

reference/operator/update/sort/#sort-array-elements-that-are-not-documents

sort

public PushOptions sort(@Nullable
                        Integer sort)

Sets the sort direction for sorting array elements that are not documents.

Parameters:

sort - the sort direction

Returns:

this

Throws:

IllegalStateException - if sortDocument property is already set

MongoDB documentation

$sort

reference/operator/update/sort/#sort-array-elements-that-are-not-documents

getSortDocument

@Nullable
public Bson getSortDocument()

Gets the sort direction for sorting array elements that are documents.

Returns:

the sort document

MongoDB documentation

$sort

sortDocument

public PushOptions sortDocument(@Nullable
                                Bson sortDocument)

Sets the sort direction for sorting array elements that are documents.

Parameters:

sortDocument - the sort document

Returns:

this

Throws:

IllegalStateException - if sort property is already set

MongoDB documentation

$sort

toString

public String toString()

Overrides:

toString in class Object