ResourceDescriptor

All Implemented Interfaces:
```
public final class ResourceDescriptor

                    
```
A Resource Descriptor. This contains all the information known about the resource, to allow the loading function to read the data and apply the correct charset and data conversion required.
The InputStream will already have been opened (and in the case of HTTP(S), the headers will have been read and analysed for details like character set, MIME type etc.), and it should be closed after use.

Author:

Peter Wall

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final InputStream`	`inputStream`
`private final URL`	`url`
`private final String`	`charsetName`
`private final Long`	`size`
`private final Instant`	`time`
`private final String`	`mimeType`
`private final String`	`eTag`

Constructor Summary

Constructors
Constructor	Description
`ResourceDescriptor(InputStream inputStream, URL url, String charsetName, Long size, Instant time, String mimeType, String eTag)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final InputStream`	`getInputStream()`
`final URL`	`getUrl()`
`final String`	`getCharsetName()`
`final Long`	`getSize()`
`final Instant`	`getTime()`
`final String`	`getMimeType()`
`final String`	`getETag()`
`final Reader`	`getReader(Charset defaultCharset)`	Get a Reader to read the resource.

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

- Constructor Detail
  - ResourceDescriptor
```
ResourceDescriptor(InputStream inputStream, URL url, String charsetName, Long size, Instant time, String mimeType, String eTag)
```
- Method Detail
  - getInputStream
```
 final InputStream getInputStream()
```
  - getUrl
```
 final URL getUrl()
```
  - getCharsetName
```
 final String getCharsetName()
```
  - getSize
```
 final Long getSize()
```
  - getTime
```
 final Instant getTime()
```
  - getMimeType
```
 final String getMimeType()
```
  - getETag
```
 final String getETag()
```
  - getReader
```
 final Reader getReader(Charset defaultCharset)
```
    Get a Reader to read the resource. If the resource specifies an explicit charset name, the function will attempt to locate a charset with that name, and if it is successful that charset will be used. If the resource does not specify an explicit charset name and the defaultCharset parameter is provided, that will be used. If neither is provided, the DynamicReader will choose the charset based on the content of the data (in most cases this will be the best option).
    
    Parameters:
    
    defaultCharset - the charset to use if the resource does not specify an explicit charset
    
    Returns:
    
    a Reader (but see the comment below)