EndpointGroup (filter-service-metrics 1.12 1.12 API)

All Superinterfaces:

AutoCloseable, Listenable<List<Endpoint>>, SafeCloseable

All Known Implementing Classes:

DnsAddressEndpointGroup, DnsServiceEndpointGroup, DnsTextEndpointGroup, DynamicEndpointGroup, Endpoint, HealthCheckedEndpointGroup, PropertiesEndpointGroup, StaticEndpointGroup
```
public interface EndpointGroup
extends Listenable<List<Endpoint>>, SafeCloseable
```
A list of Endpoints.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addListener(Consumer<? super List<Endpoint>> listener)` Adds a `Consumer` that will be invoked when a `Listenable` changes its value.
`default List<Endpoint>`	`awaitInitialEndpoints()` Waits until the initial `Endpoint`s are ready.
`default List<Endpoint>`	`awaitInitialEndpoints(long timeout, TimeUnit unit)` Waits until the initial `Endpoint`s are ready, with timeout.
`default void`	`close()`
`static EndpointGroup`	`empty()` Returns a singleton `EndpointGroup` which does not contain any `Endpoint`s.
`List<Endpoint>`	`endpoints()` Return the endpoints held by this `EndpointGroup`.
`CompletableFuture<List<Endpoint>>`	`initialEndpointsFuture()` Returns a `CompletableFuture` which is completed when the initial `Endpoint`s are ready.
`static EndpointGroup`	`of(EndpointGroup... endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`static EndpointGroup`	`of(Iterable<? extends EndpointGroup> endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`default EndpointGroup`	`orElse(EndpointGroup nextEndpointGroup)`
`default void`	`removeListener(Consumer<?> listener)` Remove a listener.

- Method Detail
  - empty
```
static EndpointGroup empty()
```
    Returns a singleton EndpointGroup which does not contain any Endpoints.
  - of
```
static EndpointGroup of(EndpointGroup... endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.
  - of
```
static EndpointGroup of(Iterable<? extends EndpointGroup> endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.
  - endpoints
```
List<Endpoint> endpoints()
```
    Return the endpoints held by this EndpointGroup.
  - initialEndpointsFuture
```
CompletableFuture<List<Endpoint>> initialEndpointsFuture()
```
    Returns a CompletableFuture which is completed when the initial Endpoints are ready.
  - awaitInitialEndpoints
```
default List<Endpoint> awaitInitialEndpoints()
                                      throws InterruptedException
```
    Waits until the initial Endpoints are ready.
    
    Throws:
    
    CancellationException - if close() was called before the initial Endpoints are set
    
    InterruptedException
  - awaitInitialEndpoints
```
default List<Endpoint> awaitInitialEndpoints(long timeout,
                                             TimeUnit unit)
                                      throws InterruptedException,
                                             TimeoutException
```
    Waits until the initial Endpoints are ready, with timeout.
    
    Throws:
    
    CancellationException - if close() was called before the initial Endpoints are set
    
    TimeoutException - if the initial Endpoints are not set until timeout
    
    InterruptedException
  - addListener
```
default void addListener(Consumer<? super List<Endpoint>> listener)
```
    Description copied from interface: Listenable
    
    Adds a Consumer that will be invoked when a Listenable changes its value.
    
    Specified by:
    
    addListener in interface Listenable<List<Endpoint>>
  - removeListener
```
default void removeListener(Consumer<?> listener)
```
    Description copied from interface: Listenable
    
    Remove a listener.
    
    Specified by:
    
    removeListener in interface Listenable<List<Endpoint>>
  - close
```
default void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface SafeCloseable
  - orElse
```
default EndpointGroup orElse(EndpointGroup nextEndpointGroup)
```

Interface EndpointGroup

Method Summary

Method Detail

empty

of

of

endpoints

initialEndpointsFuture

awaitInitialEndpoints

awaitInitialEndpoints

addListener

removeListener

close

orElse