Closable.CloseBuilder (org.refcodes:refcodes-component 2.1.6 API)

Type Parameters:

B - The instance to be returned on which to apply succeeding builder operations.

All Known Subinterfaces:

ConnectionComponent.ConnectionComponentBuilder<CON,B>, LinkComponent.LinkComponentBuilder<B>

Enclosing interface:

Closable
```
public static interface Closable.CloseBuilder<B extends Closable.CloseBuilder<B>>
```
To enable the Closable functionality to be invoked in a builder chain.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`B`	`withClose()`	Builder method for the `Closable.close()` method.
`B`	`withCloseIn(int aCloseInMillis)`	Builder method for the `Closable.closeIn( int )` method.
`B`	`withCloseQuietly()`	Builder method for the `Closable.closeQuietly()` method.
`default B`	`withCloseUnchecked()`	Closes the component by calling `withClose()` without you to require catching an `IOException`.

- Method Detail
  - withClose
```
B withClose()
     throws IOException
```
    Builder method for the Closable.close() method.
    
    Returns:
    
    The instance to be returned on which to apply succeeding builder operations.
    
    Throws:
    
    IOException - in case closing or pre-closing (flushing) fails.
  - withCloseQuietly
```
B withCloseQuietly()
```
    Builder method for the Closable.closeQuietly() method.
    
    Returns:
    
    The instance to be returned on which to apply succeeding builder operations.
  - withCloseIn
```
B withCloseIn(int aCloseInMillis)
```
    Builder method for the Closable.closeIn( int ) method.
    
    Parameters:
    
    aCloseInMillis - The time in milliseconds to pass till Closable.close() is called.
    
    Returns:
    
    The instance to be returned on which to apply succeeding builder operations.
  - withCloseUnchecked
```
default B withCloseUnchecked()
```
    Closes the component by calling withClose() without you to require catching an IOException.
    
    Returns:
    
    The instance to be returned on which to apply succeeding builder operations.
    
    Throws:
    
    org.refcodes.exception.IORuntimeException - encapsulates the cause and is thrown upon encountering a IOException exception