StubHttpResponse (cauli-server 1.2 API)

java.lang.Object
- org.cauli.server.stub.StubHttpResponse

所有已实现的接口:

HttpResponse
```
public class StubHttpResponse
extends Object
implements HttpResponse
```
Implementation of HttpResponse that is easy to construct manually, and inspect results. Useful for testing.

字段概要

字段
限定符和类型	字段和说明
`private Charset`	`charset`
`private ByteArrayOutputStream`	`contents`
`private List<HttpCookie>`	`cookies`
`private boolean`	`ended`
`private Throwable`	`error`
`private Map<String,String>`	`headers`
`private int`	`status`

构造器概要

构造器
构造器和说明

StubHttpResponse()

构造器
构造器和说明
`StubHttpResponse()`

方法概要

方法
限定符和类型	方法和说明
`Charset`	`charset()` Current Charset used to encode to response as.
`StubHttpResponse`	`charset(Charset charset)` For text based responses, sets the Charset to encode the response as.
`StubHttpResponse`	`chunked()` Turns the response into a chunked response after this method is called, `HttpResponse.write(String)` should be used to send chunks
`boolean`	`containsHeader(String name)` Test to see if this response has a header of the specified name
`StubHttpResponse`	`content(byte[] content)` Write binary based content back to the client.
`StubHttpResponse`	`content(ByteBuffer buffer)` Write binary based content back to the client.
`StubHttpResponse`	`content(String content)` Write text based content back to the client.
`byte[]`	`contents()`
`String`	`contentsString()`
`StubHttpResponse`	`cookie(HttpCookie httpCookie)` Adds a cookie
`StubHttpResponse`	`cookie(String name, String value)`
`List<HttpCookie>`	`cookies()`
`StubHttpResponse`	`end()` Marks the response as ended.
`boolean`	`ended()`
`Throwable`	`error()`
`StubHttpResponse`	`error(Throwable error)` Marks the response as erroneous.
`String`	`header(String name)`
`StubHttpResponse`	`header(String name, Date value)` Adds a Date (RFC 1123 format) HTTP header.
`StubHttpResponse`	`header(String name, long value)` Adds a numeric HTTP header.
`StubHttpResponse`	`header(String name, String value)` Adds an HTTP header.
`int`	`status()` Retrieve HTTP status code that this response is going to return.
`StubHttpResponse`	`status(int status)` Sets the HTTP status code.
`String`	`toString()`
`StubHttpResponse`	`write(String content)` Writes immediately to the client without closing the connection.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - charset
```
private Charset charset
```
  - status
```
private int status
```
  - headers
```
private Map<String,String> headers
```
  - error
```
private Throwable error
```
  - ended
```
private boolean ended
```
  - contents
```
private ByteArrayOutputStream contents
```
  - cookies
```
private List<HttpCookie> cookies
```
- 构造器详细资料
  - StubHttpResponse
```
public StubHttpResponse()
```
- 方法详细资料
  - charset
```
public StubHttpResponse charset(Charset charset)
```
    从接口复制的说明: HttpResponse
    
    For text based responses, sets the Charset to encode the response as.
    If not set, defaults to UTF8.
    
    指定者:
    
    charset 在接口中 HttpResponse
  - charset
```
public Charset charset()
```
    从接口复制的说明: HttpResponse
    
    Current Charset used to encode to response as.
    
    指定者:
    
    charset 在接口中 HttpResponse
    
    另请参阅:
    HttpResponse.charset(java.nio.charset.Charset)
  - chunked
```
public StubHttpResponse chunked()
```
    从接口复制的说明: HttpResponse
    
    Turns the response into a chunked response
    after this method is called, HttpResponse.write(String) should be used to send chunks
    
    指定者:
    
    chunked 在接口中 HttpResponse
  - status
```
public StubHttpResponse status(int status)
```
    从接口复制的说明: HttpResponse
    
    Sets the HTTP status code.
    Defaults to 200 (OK).
    
    指定者:
    
    status 在接口中 HttpResponse
  - status
```
public int status()
```
    从接口复制的说明: HttpResponse
    
    Retrieve HTTP status code that this response is going to return.
    
    指定者:
    
    status 在接口中 HttpResponse
    
    另请参阅:
    HttpResponse.status(int)
  - header
```
public StubHttpResponse header(String name,
                      String value)
```
    从接口复制的说明: HttpResponse
    
    Adds an HTTP header. Multiple HTTP headers can be added with the same name.
    
    指定者:
    
    header 在接口中 HttpResponse
  - header
```
public StubHttpResponse header(String name,
                      long value)
```
    从接口复制的说明: HttpResponse
    
    Adds a numeric HTTP header. Multiple HTTP headers can be added with the same name.
    
    指定者:
    
    header 在接口中 HttpResponse
  - header
```
public StubHttpResponse header(String name,
                      Date value)
```
    从接口复制的说明: HttpResponse
    
    Adds a Date (RFC 1123 format) HTTP header. Multiple HTTP headers can be added with the same name.
    
    指定者:
    
    header 在接口中 HttpResponse
  - cookie
```
public StubHttpResponse cookie(HttpCookie httpCookie)
```
    从接口复制的说明: HttpResponse
    
    Adds a cookie
    
    指定者:
    
    cookie 在接口中 HttpResponse
    
    参数:
    httpCookie - the cookie
  - cookie
```
public StubHttpResponse cookie(String name,
                      String value)
```
  - header
```
public String header(String name)
```
  - containsHeader
```
public boolean containsHeader(String name)
```
    从接口复制的说明: HttpResponse
    
    Test to see if this response has a header of the specified name
    
    指定者:
    
    containsHeader 在接口中 HttpResponse
  - content
```
public StubHttpResponse content(String content)
```
    从接口复制的说明: HttpResponse
    
    Write text based content back to the client.
    
    指定者:
    
    content 在接口中 HttpResponse
    
    另请参阅:
    HttpResponse.charset(java.nio.charset.Charset), HttpResponse.content(byte[])
  - write
```
public StubHttpResponse write(String content)
```
    从接口复制的说明: HttpResponse
    
    Writes immediately to the client without closing the connection. (The HttpResponse.content(String) method caches content until HttpResponse.end() is called()
    TODO: Make content write immediately instead and remove this method?
    
    指定者:
    
    write 在接口中 HttpResponse
    
    参数:
    content - what to write
  - content
```
public StubHttpResponse content(byte[] content)
```
    从接口复制的说明: HttpResponse
    
    Write binary based content back to the client.
    
    指定者:
    
    content 在接口中 HttpResponse
    
    另请参阅:
    HttpResponse.content(String)
  - content
```
public StubHttpResponse content(ByteBuffer buffer)
```
    从接口复制的说明: HttpResponse
    
    Write binary based content back to the client.
    
    指定者:
    
    content 在接口中 HttpResponse
    
    另请参阅:
    HttpResponse.content(String)
  - contents
```
public byte[] contents()
```
  - contentsString
```
public String contentsString()
```
  - error
```
public StubHttpResponse error(Throwable error)
```
    从接口复制的说明: HttpResponse
    
    Marks the response as erroneous. The error shall be displayed to the user (500 SERVER ERROR) and the connection closed.
    Every response should have either HttpResponse.end() or HttpResponse.error(Throwable) called. No more operations should be performed on a response after these.
    
    指定者:
    
    error 在接口中 HttpResponse
  - error
```
public Throwable error()
```
  - end
```
public StubHttpResponse end()
```
    从接口复制的说明: HttpResponse
    
    Marks the response as ended. At this point any remaining data shall be flushed and the connection closed.
    Every response should have either HttpResponse.end() or HttpResponse.error(Throwable) called. No more operations should be performed on a response after these.
    
    指定者:
    
    end 在接口中 HttpResponse
  - ended
```
public boolean ended()
```
  - cookies
```
public List<HttpCookie> cookies()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 StubHttpResponse

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

charset

status

headers

error

ended

contents

cookies

构造器详细资料

StubHttpResponse

方法详细资料

charset

charset

chunked

status

status

header

header

header

cookie

cookie

header

containsHeader

content

write

content

content

contents

contentsString

error

error

end

ended

cookies

toString