AsyncFileLock (Vert.x Stack - Docs 4.5.11 API)

java.lang.Object
- io.vertx.rxjava.core.file.AsyncFileLock

```
public class AsyncFileLock
extends Object
```
A lock on a region of an AsyncFile.
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<AsyncFileLock> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<AsyncFileLock>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

AsyncFileLock(AsyncFileLock delegate)

AsyncFileLock(Object delegate)

Constructors
Constructor and Description
`AsyncFileLock(AsyncFileLock delegate)`
`AsyncFileLock(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`AsyncFileLock`	`getDelegate()`
`int`	`hashCode()`
`boolean`	`isShared()`
`void`	`isValid()` Like `isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)` but the `handler` will be called when the operation completes or if an error occurs.
`void`	`isValid(Handler<AsyncResult<Boolean>> handler)` Like `isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)` but the `handler` will be called when the operation completes or if an error occurs.
`boolean`	`isValidBlocking()` Like `isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)` but blocking.
`static AsyncFileLock`	`newInstance(AsyncFileLock arg)`
`boolean`	`overlaps(long position, long size)`
`long`	`position()`
`void`	`release()` Like `release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)` but the `handler` will be called when the operation completes or if an error occurs.
`void`	`release(Handler<AsyncResult<Void>> handler)` Like `release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)` but the `handler` will be called when the operation completes or if an error occurs.
`void`	`releaseBlocking()` Like `release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)` but blocking.
`Single<Boolean>`	`rxIsValid()` Like `isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)` but the `handler` will be called when the operation completes or if an error occurs.
`Single<Void>`	`rxRelease()` Like `release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)` but the `handler` will be called when the operation completes or if an error occurs.
`long`	`size()`
`String`	`toString()`

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

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<AsyncFileLock> __TYPE_ARG
```
- Constructor Detail
  - AsyncFileLock
```
public AsyncFileLock(AsyncFileLock delegate)
```
  - AsyncFileLock
```
public AsyncFileLock(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public AsyncFileLock getDelegate()
```
  - position
```
public long position()
```
    Returns:
    
    the position of the first byte of the locked region
  - size
```
public long size()
```
    Returns:
    
    the size in bytes of the locked region
  - isShared
```
public boolean isShared()
```
    Returns:
    
    true if this lock is shared, otherwise false
  - overlaps
```
public boolean overlaps(long position,
                        long size)
```
    Parameters:
    
    position -
    
    size -
    
    Returns:
    
    true if this lock overlaps with the range described by position and size, otherwise false
  - isValidBlocking
```
public boolean isValidBlocking()
```
    Like isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but blocking.
    
    Returns:
  - isValid
```
public void isValid(Handler<AsyncResult<Boolean>> handler)
```
    Like isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but the handler will be called when the operation completes or if an error occurs.
    
    Parameters:
    
    handler -
  - isValid
```
public void isValid()
```
    Like isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but the handler will be called when the operation completes or if an error occurs.
  - rxIsValid
```
public Single<Boolean> rxIsValid()
```
    Like isValid(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but the handler will be called when the operation completes or if an error occurs.
    
    Returns:
  - releaseBlocking
```
public void releaseBlocking()
```
    Like release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but blocking.
  - release
```
public void release(Handler<AsyncResult<Void>> handler)
```
    Like release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the operation completes or if an error occurs.
    
    Parameters:
    
    handler -
  - release
```
public void release()
```
    Like release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the operation completes or if an error occurs.
  - rxRelease
```
public Single<Void> rxRelease()
```
    Like release(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the operation completes or if an error occurs.
    
    Returns:
  - newInstance
```
public static AsyncFileLock newInstance(AsyncFileLock arg)
```

Class AsyncFileLock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

Constructor Detail

AsyncFileLock

AsyncFileLock

Method Detail

toString

equals

hashCode

getDelegate

position

size

isShared

overlaps

isValidBlocking

isValid

isValid

rxIsValid

releaseBlocking

release

release

rxRelease

newInstance