OutcomeBuilder (Werval API Reference (0.7.5))

```
public interface OutcomeBuilder
```
Builder for Outcomes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OutcomeBuilder`	`as(String contentType)`
`OutcomeBuilder`	`asHtml()`
`OutcomeBuilder`	`asHtml(Charset charset)`
`OutcomeBuilder`	`asJson()`
`OutcomeBuilder`	`asJson(Charset charset)`
`OutcomeBuilder`	`asTextPlain()`
`OutcomeBuilder`	`asTextPlain(Charset charset)`
`OutcomeBuilder`	`asTextual(String contentType)`
`OutcomeBuilder`	`asTextual(String contentType, Charset charset)`
`OutcomeBuilder`	`asXml()`
`OutcomeBuilder`	`asXml(Charset charset)`
`Outcome`	`build()`
`OutcomeBuilder`	`withBody(byte[] body)` Use a bytes body.
`OutcomeBuilder`	`withBody(CharSequence body)` Use a characters body.
`OutcomeBuilder`	`withBody(CharSequence body, Charset charset)` Use a characters body.
`OutcomeBuilder`	`withBody(InputStream body)` Use an InputStream body if undetermined length.
`OutcomeBuilder`	`withBody(InputStream body, int chunkSize)` Use an InputStream body of undetermined length.
`OutcomeBuilder`	`withBody(InputStream body, long length)` Use an InputStream body of known length.
`OutcomeBuilder`	`withHeader(String name, String value)` Use a HTTP header value.

- Method Detail
  - withHeader
```
OutcomeBuilder withHeader(String name,
                          String value)
```
    Use a HTTP header value.
    
    Parameters:
    
    name - The header name
    
    value - The header value
    
    Returns:
    
    This very OutcomeBuilder instance
  - as
```
OutcomeBuilder as(String contentType)
```
    Parameters:
    
    contentType - Outcome Content-Type
    
    Returns:
    
    This very OutcomeBuilder instance
  - asTextual
```
OutcomeBuilder asTextual(String contentType)
```
    Parameters:
    
    contentType - Outcome Content-Type
    
    Returns:
    
    This very OutcomeBuilder instance
  - asTextual
```
OutcomeBuilder asTextual(String contentType,
                         Charset charset)
```
    Parameters:
    
    contentType - Outcome Content-Type
    
    charset - Charset
    
    Returns:
    
    This very OutcomeBuilder instance
  - asJson
```
OutcomeBuilder asJson()
```
    Returns:
    
    This very OutcomeBuilder instance
  - asJson
```
OutcomeBuilder asJson(Charset charset)
```
    Parameters:
    
    charset - Charset
    
    Returns:
    
    This very OutcomeBuilder instance
  - asTextPlain
```
OutcomeBuilder asTextPlain()
```
    Returns:
    
    This very OutcomeBuilder instance
  - asTextPlain
```
OutcomeBuilder asTextPlain(Charset charset)
```
    Parameters:
    
    charset - Charset
    
    Returns:
    
    This very OutcomeBuilder instance
  - asXml
```
OutcomeBuilder asXml()
```
    Returns:
    
    This very OutcomeBuilder instance
  - asXml
```
OutcomeBuilder asXml(Charset charset)
```
    Parameters:
    
    charset - Charset
    
    Returns:
    
    This very OutcomeBuilder instance
  - asHtml
```
OutcomeBuilder asHtml()
```
    Returns:
    
    This very OutcomeBuilder instance
  - asHtml
```
OutcomeBuilder asHtml(Charset charset)
```
    Parameters:
    
    charset - Charset
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(byte[] body)
```
    Use a bytes body. Content-Length header will be set and identity Transfer-Encoding used.
    
    Parameters:
    
    body - Body bytes
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(CharSequence body)
```
    Use a characters body. Content-Length header will be set and identity Transfer-Encoding used.
    
    Parameters:
    
    body - Body as CharSequence
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(CharSequence body,
                        Charset charset)
```
    Use a characters body. Content-Length header will be set and identity Transfer-Encoding used.
    
    Parameters:
    
    body - Body as CharSequence
    
    charset - Character encoding to use
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(InputStream body)
```
    Use an InputStream body if undetermined length. Content-Length header will NOT be set and chunked Transfer-Encoding used.
    Use a chunk size as configured in werval.http.chunksize
    
    Parameters:
    
    body - Body InputStream
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(InputStream body,
                        int chunkSize)
```
    Use an InputStream body of undetermined length.
    Content-Length header will NOT be set and chunked Transfer-Encoding used.
    
    Parameters:
    
    body - Body InputStream, closed once consumed
    
    chunkSize - Desired HTTP chunk size
    
    Returns:
    
    This very OutcomeBuilder instance
  - withBody
```
OutcomeBuilder withBody(InputStream body,
                        long length)
```
    Use an InputStream body of known length. Content-Length header will be set and identity Transfer-Encoding used.
    
    Parameters:
    
    body - Body InputStream, closed once consumed
    
    length - Body length
    
    Returns:
    
    This very OutcomeBuilder instance
  - build
```
Outcome build()
```
    Returns:
    
    A new Outcome instance

Interface OutcomeBuilder

Method Summary

Method Detail

withHeader

as

asTextual

asTextual

asJson

asJson

asTextPlain

asTextPlain

asXml

asXml

asHtml

asHtml

withBody

withBody

withBody

withBody

withBody

withBody

build