Readable (javadoc 2.0.3 API)

All Superinterfaces:

Named
```
@Immutable
public interface Readable
extends Named
```
Abstraction over File and URL based I/O.

Since:

1.1.0

Author:

graemerocher

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.io.InputStream`	`asInputStream()` Represent this Readable as an input stream.
`default java.io.Reader`	`asReader()` Obtain a `Reader` for this readable using `StandardCharsets.UTF_8`.
`default java.io.Reader`	`asReader(java.nio.charset.Charset charset)` Obtain a `Reader` for this readable.
`boolean`	`exists()` Does the underlying readable resource exist.
`static Readable`	`of(java.io.File file)` Create a `Readable` for the given file.
`static Readable`	`of(java.nio.file.Path path)` Create a `Readable` for the given path.
`static Readable`	`of(java.net.URL url)` Create a `Readable` for the given URL.

Methods inherited from interface io.micronaut.core.naming.Named
getName

- Method Detail
  - asInputStream
```
@NonNull
java.io.InputStream asInputStream()
                                    throws java.io.IOException
```
    Represent this Readable as an input stream.
    
    Returns:
    
    The input stream
    
    Throws:
    
    java.io.IOException - if an I/O exception occurs
  - exists
```
boolean exists()
```
    Does the underlying readable resource exist.
    
    Returns:
    
    True if it does
  - asReader
```
default java.io.Reader asReader()
                         throws java.io.IOException
```
    Obtain a Reader for this readable using StandardCharsets.UTF_8.
    
    Returns:
    
    The reader
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - asReader
```
default java.io.Reader asReader(java.nio.charset.Charset charset)
                         throws java.io.IOException
```
    Obtain a Reader for this readable.
    
    Parameters:
    
    charset - The charset to use
    
    Returns:
    
    The reader
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - of
```
@NonNull
static Readable of(@NonNull
                            java.net.URL url)
```
    Create a Readable for the given URL.
    
    Parameters:
    
    url - The URL
    
    Returns:
    
    The readable.
  - of
```
@NonNull
static Readable of(@NonNull
                            java.io.File file)
```
    Create a Readable for the given file.
    
    Parameters:
    
    file - The file
    
    Returns:
    
    The readable.
  - of
```
@NonNull
static Readable of(@NonNull
                            java.nio.file.Path path)
```
    Create a Readable for the given path.
    
    Parameters:
    
    path - The path
    
    Returns:
    
    The readable.

Interface Readable

Method Summary

Methods inherited from interface io.micronaut.core.naming.Named

Method Detail

asInputStream

exists

asReader

asReader

of

of

of