AsyncCloseableSupport (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.util.AsyncCloseableSupport

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, AutoCloseable
```
public final class AsyncCloseableSupport
extends Object
implements ListenableAsyncCloseable
```
Provides support for implementing AsyncCloseable or ListenableAsyncCloseable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Releases any underlying resources held by this object synchronously.
`CompletableFuture<?>`	`closeAsync()` Releases any underlying resources held by this object asynchronously.
`static AsyncCloseableSupport`	`closed()` Returns the `AsyncCloseableSupport` which has been closed already.
`boolean`	`isClosed()` Returns whether `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` operation has been completed.
`boolean`	`isClosing()` Returns whether `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` has been called.
`static AsyncCloseableSupport`	`of()` Returns a new `AsyncCloseableSupport` that will be completed immediately on `close()` or `closeAsync()`.
`static AsyncCloseableSupport`	`of(Consumer<CompletableFuture<?>> closeAction)` Returns a new `AsyncCloseableSupport` which calls the specified `Consumer` on `close()` or `closeAsync()`.
`CompletableFuture<?>`	`whenClosed()` Returns the `CompletableFuture` which is completed after the `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` operation is completed.

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

- Method Detail
  - of
```
public static AsyncCloseableSupport of()
```
    Returns a new AsyncCloseableSupport that will be completed immediately on close() or closeAsync(). This method is useful when you don't have any resources to release.
```
 > public class MyClass implements ListenableAsyncCloseable {
 >     final AsyncCloseableSupport closeable = AsyncCloseableSupport.of();
 >
 >     public void doSomething() {
 >         if (closeable.isClosing()) {
 >             throw new IllegalStateException("Closed already");
 >         }
 >         ...
 >     }
 >
 >     @Override
 >     public boolean isClosing() { return closeable.isClosing(); }
 >
 >     @Override
 >     public CompletableFuture<?> whenClosed() { return closeable.whenClosed(); }
 >
 >     @Override
 >     public CompletableFuture<?> closeAsync() { return closeable.closeAsync(); }
 >
 >     @Override
 >     public void close() { closeable.close(); }
 > }
 
```
  - of
```
public static AsyncCloseableSupport of(Consumer<CompletableFuture<?>> closeAction)
```
    Returns a new AsyncCloseableSupport which calls the specified Consumer on close() or closeAsync().
```
 > class MyClass implements ListenableAsyncCloseable {
 >     final AsyncCloseableSupport closeable = AsyncCloseableSupport.of(f -> {
 >         // Release resources here.
 >         ...
 >         f.complete(null);
 >     });
 >
 >     @Override
 >     public boolean isClosing() { return closeable.isClosing(); }
 >
 >     @Override
 >     public CompletableFuture<?> whenClosed() { return closeable.whenClosed(); }
 >
 >     @Override
 >     public CompletableFuture<?> closeAsync() { return closeable.closeAsync(); }
 >
 >     @Override
 >     public void close() { closeable.close(); }
 > }
 
```
    Parameters:
    
    closeAction - the Consumer which performs the task that release the resources and completes the given CompletableFuture.
  - closed
```
public static AsyncCloseableSupport closed()
```
    Returns the AsyncCloseableSupport which has been closed already.
  - isClosing
```
public boolean isClosing()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
    
    Specified by:
    
    isClosing in interface ListenableAsyncCloseable
    
    See Also:
    
    ListenableAsyncCloseable.isClosed()
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
    
    Specified by:
    
    isClosed in interface ListenableAsyncCloseable
    
    See Also:
    
    ListenableAsyncCloseable.isClosing()
  - closeAsync
```
public CompletableFuture<?> closeAsync()
```
    Description copied from interface: AsyncCloseable
    
    Releases any underlying resources held by this object asynchronously.
    
    Specified by:
    
    closeAsync in interface AsyncCloseable
    
    Returns:
    
    the CompletableFuture which is completed after the resources are released
  - close
```
public void close()
```
    Description copied from interface: AsyncCloseable
    
    Releases any underlying resources held by this object synchronously.
    
    Specified by:
    
    close in interface AsyncCloseable
    
    Specified by:
    
    close in interface AutoCloseable
  - whenClosed
```
public CompletableFuture<?> whenClosed()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.
    
    Specified by:
    
    whenClosed in interface ListenableAsyncCloseable

Class AsyncCloseableSupport

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

closed

isClosing

isClosed

closeAsync

close

whenClosed