com.sequoiadb.base.options

Class DeleteOption

java.lang.Object

com.sequoiadb.base.options.DeleteOption

All Implemented Interfaces:

Cloneable

public class DeleteOption
extends Object

The optional parameter of the delete operation.

Since:

3.4.5/5.0.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLG_DELETE_ONE The flag represent whether to delete only one matched record or all matched records

Constructor Summary

Constructors

Constructor and Description
DeleteOption()

Method Summary

Modifier and Type	Method and Description
void	appendFlag(int flag) Appends a new flag to the delete option.
Object	clone()
void	eraseFlag(int flag) Erases the specified flag from the delete option.
int	getFlag() Gets the flag option.
BSONObject	getHint() Gets the hint option.
DeleteOption	setFlag(int flag) Sets the flag option.
DeleteOption	setHint(BSONObject hint) Sets the hint option, default is null.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FLG_DELETE_ONE

public static final int FLG_DELETE_ONE

The flag represent whether to delete only one matched record or all matched records

See Also:

Constant Field Values

Constructor Detail

DeleteOption

public DeleteOption()

Method Detail

appendFlag

public void appendFlag(int flag)

Appends a new flag to the delete option.

Parameters:

flag - The delete flag, the following values:

• FLG_DELETE_ONE

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

eraseFlag

public void eraseFlag(int flag)

Erases the specified flag from the delete option.

Parameters:

flag - The delete flag, the following values:

• FLG_DELETE_ONE

getFlag

public int getFlag()

Gets the flag option.

Returns:

The value of flag option.

getHint

public BSONObject getHint()

Gets the hint option.

Returns:

A BSONObject of the hint option.

setFlag

public DeleteOption setFlag(int flag)

Sets the flag option.

Parameters:

flag - The delete flag, default to be 0, the following values:

• FLG_DELETE_ONE

Returns:

this

setHint

public DeleteOption setHint(BSONObject hint)

Sets the hint option, default is null.

Parameters:

hint - Specified the index used to scan data. e.g. {"":"ageIndex"} means using index "ageIndex" to scan data(index scan); {"":null} means table scan. when hint is null, database automatically match the optimal index to scan data.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object