NullSafeUpdate (datastore-utils 5.0.0 API)

java.lang.Object
- org.swat.mongo.dao.NullSafeUpdate

```
public class NullSafeUpdate
extends Object
```
The type Null safe update. It has most of the methods from Update

Constructor Summary

Constructors
Constructor and Description
`NullSafeUpdate()` Instantiates a new Null safe update.
`NullSafeUpdate(org.springframework.data.mongodb.core.query.Update update)` Instantiates a new Null safe update.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.springframework.data.mongodb.core.query.Update.AddToSetBuilder`	`addToSet(String key)` Add to set add to set builder.
`NullSafeUpdate`	`addToSet(String key, Object value)` Add to set null safe update.
`org.springframework.data.mongodb.core.query.Update.BitwiseOperatorBuilder`	`bitwise(String key)` Bitwise bitwise operator builder.
`NullSafeUpdate`	`currentDate(String key)` Current date null safe update.
`NullSafeUpdate`	`currentTimestamp(String key)` Current timestamp null safe update.
`boolean`	`equals(Object obj)`
`org.springframework.data.mongodb.core.query.Update`	`getUpdate()` Gets update.
`org.bson.Document`	`getUpdateObject()` Gets update object.
`int`	`hashCode()`
`NullSafeUpdate`	`inc(String key, Number inc)` Inc null safe update.
`protected boolean`	`isValid(Object value)` Is valid boolean.
`NullSafeUpdate`	`max(String key, Object value)` Max null safe update.
`NullSafeUpdate`	`min(String key, Object value)` Min null safe update.
`boolean`	`modifies(String key)` Modifies boolean.
`NullSafeUpdate`	`multiply(String key, Number multiplier)` Multiply null safe update.
`org.springframework.data.mongodb.core.query.Update`	`pop(String key, org.springframework.data.mongodb.core.query.Update.Position pos)` Pop update.
`NullSafeUpdate`	`pull(String key, Object value)` Pull null safe update.
`NullSafeUpdate`	`pullAll(String key, Object[] values)` Pull all null safe update.
`org.springframework.data.mongodb.core.query.Update.PushOperatorBuilder`	`push(String key)` Push push operator builder.
`NullSafeUpdate`	`push(String key, Object value)` Push null safe update.
`NullSafeUpdate`	`pushAll(String key, Object[] values)` Push all null safe update.
`NullSafeUpdate`	`rename(String oldName, String newName)` Rename null safe update.
`NullSafeUpdate`	`set(String key, Object value)` Set null safe update.
`NullSafeUpdate`	`setOnInsert(String key, Object value)` Sets on insert.
`String`	`toString()`
`NullSafeUpdate`	`unset(String key)` Unset null safe update.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- NullSafeUpdate
```
public NullSafeUpdate()
```
  Instantiates a new Null safe update.
- NullSafeUpdate
```
public NullSafeUpdate(org.springframework.data.mongodb.core.query.Update update)
```
  Instantiates a new Null safe update.
  
  Parameters:
  
  update - the update

Method Detail

getUpdate

public org.springframework.data.mongodb.core.query.Update getUpdate()

Gets update.

Returns:: the update

set

public NullSafeUpdate set(String key,
                          Object value)

Set null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

setOnInsert

public NullSafeUpdate setOnInsert(String key,
                                  Object value)

Sets on insert.

Parameters:: key - the key; value - the value
Returns:: the on insert

unset
```
public NullSafeUpdate unset(String key)
```
Unset null safe update.

Parameters:

key - the key

Returns:

the null safe update

inc

public NullSafeUpdate inc(String key,
                          Number inc)

Inc null safe update.

Parameters:: key - the key; inc - the inc
Returns:: the null safe update

push

public NullSafeUpdate push(String key,
                           Object value)

Push null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

pushAll

public NullSafeUpdate pushAll(String key,
                              Object[] values)

Push all null safe update.

Parameters:: key - the key; values - the values
Returns:: the null safe update

addToSet

public org.springframework.data.mongodb.core.query.Update.AddToSetBuilder addToSet(String key)

Add to set add to set builder.

Parameters:: key - the key
Returns:: the add to set builder

addToSet

public NullSafeUpdate addToSet(String key,
                               Object value)

Add to set null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

pull

public NullSafeUpdate pull(String key,
                           Object value)

Pull null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

pullAll

public NullSafeUpdate pullAll(String key,
                              Object[] values)

Pull all null safe update.

Parameters:: key - the key; values - the values
Returns:: the null safe update

rename

public NullSafeUpdate rename(String oldName,
                             String newName)

Rename null safe update.

Parameters:: oldName - the old name; newName - the new name
Returns:: the null safe update

currentDate
```
public NullSafeUpdate currentDate(String key)
```
Current date null safe update.

Parameters:

key - the key

Returns:

the null safe update

currentTimestamp
```
public NullSafeUpdate currentTimestamp(String key)
```
Current timestamp null safe update.

Parameters:

key - the key

Returns:

the null safe update

multiply

public NullSafeUpdate multiply(String key,
                               Number multiplier)

Multiply null safe update.

Parameters:: key - the key; multiplier - the multiplier
Returns:: the null safe update

max

public NullSafeUpdate max(String key,
                          Object value)

Max null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

min

public NullSafeUpdate min(String key,
                          Object value)

Min null safe update.

Parameters:: key - the key; value - the value
Returns:: the null safe update

bitwise

public org.springframework.data.mongodb.core.query.Update.BitwiseOperatorBuilder bitwise(String key)

Bitwise bitwise operator builder.

Parameters:: key - the key
Returns:: the bitwise operator builder

getUpdateObject
```
public org.bson.Document getUpdateObject()
```
Gets update object.

Returns:

the update object

modifies
```
public boolean modifies(String key)
```
Modifies boolean.

Parameters:

key - the key

Returns:

the boolean

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

push

public org.springframework.data.mongodb.core.query.Update.PushOperatorBuilder push(String key)

Push push operator builder.

Parameters:: key - the key
Returns:: the push operator builder

pop

public org.springframework.data.mongodb.core.query.Update pop(String key,
                                                              org.springframework.data.mongodb.core.query.Update.Position pos)

Pop update.

Parameters:: key - the key; pos - the pos
Returns:: the update

isValid
```
protected boolean isValid(Object value)
```
Is valid boolean.

Parameters:

value - the value

Returns:

the boolean

Class NullSafeUpdate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NullSafeUpdate

NullSafeUpdate

Method Detail

getUpdate

set

setOnInsert

unset

inc

push

pushAll

addToSet

addToSet

pull

pullAll

rename

currentDate

currentTimestamp

multiply

max

min

bitwise

getUpdateObject

modifies

hashCode

equals

toString

push

pop

isValid