# AtomicLongFieldUpdater

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Protected Ctors](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#proctors)\|[Methods](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#inhmethods)  

# AtomicLongFieldUpdater

`
public


abstract
class
AtomicLongFieldUpdater
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|---------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.util.concurrent.atomic.AtomicLongFieldUpdater\<T\> |

<br />

*** ** * ** ***

A reflection-based utility that enables atomic updates to designated`volatile long`fields of designated classes. This class is designed for use in atomic data structures in which several fields of the same node are independently subject to atomic updates.

Note that the guarantees of the`compareAndSet`method in this class are weaker than in other atomic classes. Because this class cannot ensure that all uses of the field are appropriate for purposes of atomic access, it can guarantee atomicity only with respect to other invocations of`compareAndSet`and`set`on the same updater.

Object arguments for parameters of type`T`that are not instances of the class passed to[newUpdater(Class, String)](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#newUpdater(java.lang.Class<U>,%20java.lang.String))will result in a[ClassCastException](https://developer.android.com/reference/java/lang/ClassCastException)being thrown.

## Summary

|                                                                                            ### Protected constructors                                                                                            ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[AtomicLongFieldUpdater](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#AtomicLongFieldUpdater())`() ` Protected do-nothing constructor for use by subclasses. |

|                                                                                                                                                                                                                                                                                                                                                                                                                ### Public methods                                                                                                                                                                                                                                                                                                                                                                                                                 ||
|-----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` final long`                                                                                                                           | ` `[accumulateAndGet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#accumulateAndGet(T,%20long,%20java.util.function.LongBinaryOperator))`(T obj, long x, `[LongBinaryOperator](https://developer.android.com/reference/java/util/function/LongBinaryOperator)` accumulatorFunction) ` Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the updated value.  |
| ` long`                                                                                                                                 | ` `[addAndGet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#addAndGet(T,%20long))`(T obj, long delta) ` Atomically adds the given value to the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ` abstract boolean`                                                                                                                     | ` `[compareAndSet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#compareAndSet(T,%20long,%20long))`(T obj, long expect, long update) ` Atomically sets the field of the given object managed by this updater to the given updated value if the current value`==`the expected value.                                                                                                                                                                                                                                                                                                                                                                         |
| ` long`                                                                                                                                 | ` `[decrementAndGet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#decrementAndGet(T))`(T obj) ` Atomically decrements by one the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` abstract long`                                                                                                                        | ` `[get](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#get(T))`(T obj) ` Returns the current value held in the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` final long`                                                                                                                           | ` `[getAndAccumulate](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndAccumulate(T,%20long,%20java.util.function.LongBinaryOperator))`(T obj, long x, `[LongBinaryOperator](https://developer.android.com/reference/java/util/function/LongBinaryOperator)` accumulatorFunction) ` Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the previous value. |
| ` long`                                                                                                                                 | ` `[getAndAdd](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndAdd(T,%20long))`(T obj, long delta) ` Atomically adds the given value to the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ` long`                                                                                                                                 | ` `[getAndDecrement](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndDecrement(T))`(T obj) ` Atomically decrements by one the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` long`                                                                                                                                 | ` `[getAndIncrement](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndIncrement(T))`(T obj) ` Atomically increments by one the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` long`                                                                                                                                 | ` `[getAndSet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndSet(T,%20long))`(T obj, long newValue) ` Atomically sets the field of the given object managed by this updater to the given value and returns the old value.                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ` final long`                                                                                                                           | ` `[getAndUpdate](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#getAndUpdate(T,%20java.util.function.LongUnaryOperator))`(T obj, `[LongUnaryOperator](https://developer.android.com/reference/java/util/function/LongUnaryOperator)` updateFunction) ` Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function, returning the previous value.                                                                 |
| ` long`                                                                                                                                 | ` `[incrementAndGet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#incrementAndGet(T))`(T obj) ` Atomically increments by one the current value of the field of the given object managed by this updater.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` abstract void`                                                                                                                        | ` `[lazySet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#lazySet(T,%20long))`(T obj, long newValue) ` Eventually sets the field of the given object managed by this updater to the given updated value.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ` static <U> `[AtomicLongFieldUpdater](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater)`<U>` | ` `[newUpdater](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#newUpdater(java.lang.Class<U>,%20java.lang.String))`(`[Class](https://developer.android.com/reference/java/lang/Class)`<U> tclass, `[String](https://developer.android.com/reference/java/lang/String)` fieldName) ` Creates and returns an updater for objects with the given field.                                                                                                                                                                                                                                                                                                         |
| ` abstract void`                                                                                                                        | ` `[set](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#set(T,%20long))`(T obj, long newValue) ` Sets the field of the given object managed by this updater to the given updated value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ` final long`                                                                                                                           | ` `[updateAndGet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#updateAndGet(T,%20java.util.function.LongUnaryOperator))`(T obj, `[LongUnaryOperator](https://developer.android.com/reference/java/util/function/LongUnaryOperator)` updateFunction) ` Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function, returning the updated value.                                                                  |
| ` abstract boolean`                                                                                                                     | ` `[weakCompareAndSet](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater#weakCompareAndSet(T,%20long,%20long))`(T obj, long expect, long update) ` Atomically sets the field of the given object managed by this updater to the given updated value if the current value`==`the expected value.                                                                                                                                                                                                                                                                                                                                                                 |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Protected constructors

### AtomicLongFieldUpdater

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
protected AtomicLongFieldUpdater ()
```

Protected do-nothing constructor for use by subclasses.

<br />

## Public methods

### accumulateAndGet

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final long accumulateAndGet (T obj, 
                long x, 
                LongBinaryOperator accumulatorFunction)
```

Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

<br />

|                                            Parameters                                            ||
|-----------------------|---------------------------------------------------------------------------|
| `obj`                 | `T`: An object whose field to get and set <br />                          |
| `x`                   | `long`: the update value <br />                                           |
| `accumulatorFunction` | `LongBinaryOperator`: a side-effect-free function of two arguments <br /> |

|             Returns              ||
|--------|--------------------------|
| `long` | the updated value <br /> |

### addAndGet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long addAndGet (T obj, 
                long delta)
```

Atomically adds the given value to the current value of the field of the given object managed by this updater.

<br />

|                        Parameters                         ||
|---------|--------------------------------------------------|
| `obj`   | `T`: An object whose field to get and set <br /> |
| `delta` | `long`: the value to add <br />                  |

|             Returns              ||
|--------|--------------------------|
| `long` | the updated value <br /> |

### compareAndSet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract boolean compareAndSet (T obj, 
                long expect, 
                long update)
```

Atomically sets the field of the given object managed by this updater to the given updated value if the current value`==`the expected value. This method is guaranteed to be atomic with respect to other calls to`compareAndSet`and`set`, but not necessarily with respect to other changes in the field.

<br />

|                            Parameters                            ||
|----------|--------------------------------------------------------|
| `obj`    | `T`: An object whose field to conditionally set <br /> |
| `expect` | `long`: the expected value <br />                      |
| `update` | `long`: the new value <br />                           |

|                Returns                ||
|-----------|----------------------------|
| `boolean` | `true`if successful <br /> |

### decrementAndGet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long decrementAndGet (T obj)
```

Atomically decrements by one the current value of the field of the given object managed by this updater.

<br />

|                       Parameters                        ||
|-------|--------------------------------------------------|
| `obj` | `T`: An object whose field to get and set <br /> |

|             Returns              ||
|--------|--------------------------|
| `long` | the updated value <br /> |

### get

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract long get (T obj)
```

Returns the current value held in the field of the given object managed by this updater.

<br />

|                   Parameters                    ||
|-------|------------------------------------------|
| `obj` | `T`: An object whose field to get <br /> |

|             Returns              ||
|--------|--------------------------|
| `long` | the current value <br /> |

### getAndAccumulate

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final long getAndAccumulate (T obj, 
                long x, 
                LongBinaryOperator accumulatorFunction)
```

Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

<br />

|                                            Parameters                                            ||
|-----------------------|---------------------------------------------------------------------------|
| `obj`                 | `T`: An object whose field to get and set <br />                          |
| `x`                   | `long`: the update value <br />                                           |
| `accumulatorFunction` | `LongBinaryOperator`: a side-effect-free function of two arguments <br /> |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### getAndAdd

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getAndAdd (T obj, 
                long delta)
```

Atomically adds the given value to the current value of the field of the given object managed by this updater.

<br />

|                        Parameters                         ||
|---------|--------------------------------------------------|
| `obj`   | `T`: An object whose field to get and set <br /> |
| `delta` | `long`: the value to add <br />                  |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### getAndDecrement

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getAndDecrement (T obj)
```

Atomically decrements by one the current value of the field of the given object managed by this updater.

<br />

|                       Parameters                        ||
|-------|--------------------------------------------------|
| `obj` | `T`: An object whose field to get and set <br /> |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### getAndIncrement

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getAndIncrement (T obj)
```

Atomically increments by one the current value of the field of the given object managed by this updater.

<br />

|                       Parameters                        ||
|-------|--------------------------------------------------|
| `obj` | `T`: An object whose field to get and set <br /> |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### getAndSet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getAndSet (T obj, 
                long newValue)
```

Atomically sets the field of the given object managed by this updater to the given value and returns the old value.

<br />

|                          Parameters                          ||
|------------|--------------------------------------------------|
| `obj`      | `T`: An object whose field to get and set <br /> |
| `newValue` | `long`: the new value <br />                     |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### getAndUpdate

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final long getAndUpdate (T obj, 
                LongUnaryOperator updateFunction)
```

Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

<br />

|                                Parameters                                 ||
|------------------|---------------------------------------------------------|
| `obj`            | `T`: An object whose field to get and set <br />        |
| `updateFunction` | `LongUnaryOperator`: a side-effect-free function <br /> |

|              Returns              ||
|--------|---------------------------|
| `long` | the previous value <br /> |

### incrementAndGet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long incrementAndGet (T obj)
```

Atomically increments by one the current value of the field of the given object managed by this updater.

<br />

|                       Parameters                        ||
|-------|--------------------------------------------------|
| `obj` | `T`: An object whose field to get and set <br /> |

|             Returns              ||
|--------|--------------------------|
| `long` | the updated value <br /> |

### lazySet

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract void lazySet (T obj, 
                long newValue)
```

Eventually sets the field of the given object managed by this updater to the given updated value.

<br />

|                      Parameters                      ||
|------------|------------------------------------------|
| `obj`      | `T`: An object whose field to set <br /> |
| `newValue` | `long`: the new value <br />             |

### newUpdater

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static AtomicLongFieldUpdater<U> newUpdater (Class<U> tclass, 
                String fieldName)
```

Creates and returns an updater for objects with the given field. The Class argument is needed to check that reflective types and generic types match.

<br />

|                               Parameters                                ||
|-------------|------------------------------------------------------------|
| `tclass`    | `Class`: the class of the objects holding the field <br /> |
| `fieldName` | `String`: the name of the field to be updated <br />       |

|                                                                    Returns                                                                    ||
|---------------------------------------------------------------------------------------------------------------------------|--------------------|
| [AtomicLongFieldUpdater](https://developer.android.com/reference/java/util/concurrent/atomic/AtomicLongFieldUpdater)`<U>` | the updater <br /> |

|                                                                                                                                            Throws                                                                                                                                            ||
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if the field is not a volatile long type                                                                                                                                             |
| [RuntimeException](https://developer.android.com/reference/java/lang/RuntimeException)                 | with a nested reflection-based exception if the class does not hold field or is the wrong type, or the field is inaccessible to the caller according to Java language access control |

### set

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract void set (T obj, 
                long newValue)
```

Sets the field of the given object managed by this updater to the given updated value. This operation is guaranteed to act as a volatile store with respect to subsequent invocations of`compareAndSet`.

<br />

|                      Parameters                      ||
|------------|------------------------------------------|
| `obj`      | `T`: An object whose field to set <br /> |
| `newValue` | `long`: the new value <br />             |

### updateAndGet

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final long updateAndGet (T obj, 
                LongUnaryOperator updateFunction)
```

Atomically updates (with memory effects as specified by[VarHandle.compareAndSet(Object)](https://developer.android.com/reference/java/lang/invoke/VarHandle#compareAndSet(java.lang.Object[]))) the field of the given object managed by this updater with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

<br />

|                                Parameters                                 ||
|------------------|---------------------------------------------------------|
| `obj`            | `T`: An object whose field to get and set <br />        |
| `updateFunction` | `LongUnaryOperator`: a side-effect-free function <br /> |

|             Returns              ||
|--------|--------------------------|
| `long` | the updated value <br /> |

### weakCompareAndSet

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract boolean weakCompareAndSet (T obj, 
                long expect, 
                long update)
```

Atomically sets the field of the given object managed by this updater to the given updated value if the current value`==`the expected value. This method is guaranteed to be atomic with respect to other calls to`compareAndSet`and`set`, but not necessarily with respect to other changes in the field.

This operation may fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to`compareAndSet`.

<br />

|                            Parameters                            ||
|----------|--------------------------------------------------------|
| `obj`    | `T`: An object whose field to conditionally set <br /> |
| `expect` | `long`: the expected value <br />                      |
| `update` | `long`: the new value <br />                           |

|                Returns                ||
|-----------|----------------------------|
| `boolean` | `true`if successful <br /> |