org.dizitart.no2

Class UpdateOptions

java.lang.Object

org.dizitart.no2.UpdateOptions

public class UpdateOptions
extends java.lang.Object

Settings to control update operation in NitriteCollection.

Since:

1.0

See Also:

NitriteCollection.update(Filter, Document, UpdateOptions)

Constructor Summary

Constructors

Constructor and Description
UpdateOptions()

Method Summary

Modifier and Type	Method and Description
boolean	isJustOnce() Indicates if only one document will be updated or all of them.
boolean	isUpsert() Indicates if the update operation will insert a new document if it does not find any existing document to update.
void	setJustOnce(boolean justOnce) Indicates if only one document will be updated or all of them.
void	setUpsert(boolean upsert) Indicates if the update operation will insert a new document if it does not find any existing document to update.
java.lang.String	toString()
static UpdateOptions	updateOptions(boolean upsert) Creates a new UpdateOptions.
static UpdateOptions	updateOptions(boolean upsert, boolean justOnce) Creates a new UpdateOptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateOptions

public UpdateOptions()

Method Detail

updateOptions

public static UpdateOptions updateOptions(boolean upsert)

Creates a new UpdateOptions.

Parameters:

upsert - the upsert flag

Returns:

the UpdateOptions.

updateOptions

public static UpdateOptions updateOptions(boolean upsert,
                                          boolean justOnce)

Creates a new UpdateOptions.

Parameters:

upsert - the upsert flag

justOnce - the justOnce flag

Returns:

the UpdateOptions.

toString

@Generated(value="lombok")
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isUpsert

@Generated(value="lombok")
public boolean isUpsert()

Indicates if the update operation will insert a new document if it does not find any existing document to update.

filter fails to find a document to update.

Returns:

true if a new document to insert; otherwise, false.

See Also:

NitriteCollection.update(Filter, Document, UpdateOptions)

setUpsert

@Generated(value="lombok")
public void setUpsert(boolean upsert)

Indicates if the update operation will insert a new document if it does not find any existing document to update.

Parameters:

upsert - a value indicating, if a new document to insert in case the filter fails to find a document to update.

See Also:

NitriteCollection.update(Filter, Document, UpdateOptions)

isJustOnce

@Generated(value="lombok")
public boolean isJustOnce()

Indicates if only one document will be updated or all of them.

Returns:

true if only one document to update; otherwise, false.

setJustOnce

@Generated(value="lombok")
public void setJustOnce(boolean justOnce)

Indicates if only one document will be updated or all of them.

Parameters:

justOne - a value indicating if only one document to update or all.