io.servicetalk.http.api

Class HttpOutputStream

java.lang.Object

java.io.OutputStream

io.servicetalk.http.api.HttpOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public abstract class HttpOutputStream
extends java.io.OutputStream

The OutputStream which provides access to the HTTP trailers.

Constructor Summary

Constructors

Constructor and Description
HttpOutputStream()

Method Summary

Modifier and Type	Method and Description
HttpOutputStream	addTrailer(java.lang.CharSequence name, java.lang.CharSequence value) Adds a new trailer with the specified name and value.
HttpOutputStream	addTrailers(HttpHeaders trailers) Adds all trailer names and values of trailer object.
HttpOutputStream	setTrailer(java.lang.CharSequence name, java.lang.CharSequence value) Sets a trailer with the specified name and value.
HttpOutputStream	setTrailers(HttpHeaders trailers) Clears the current trailer entries and copies all trailer entries of the specified trailers object.
HttpHeaders	trailers() Gets the trailers.

Methods inherited from class java.io.OutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpOutputStream

public HttpOutputStream()

Method Detail

addTrailer

public HttpOutputStream addTrailer(java.lang.CharSequence name,
                                   java.lang.CharSequence value)

Adds a new trailer with the specified name and value.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

addTrailers

public HttpOutputStream addTrailers(HttpHeaders trailers)

Adds all trailer names and values of trailer object.

Parameters:

trailers - the trailers to add.

Returns:

this.

setTrailer

public HttpOutputStream setTrailer(java.lang.CharSequence name,
                                   java.lang.CharSequence value)

Sets a trailer with the specified name and value. Any existing trailers with the same name are overwritten.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

setTrailers

public HttpOutputStream setTrailers(HttpHeaders trailers)

Clears the current trailer entries and copies all trailer entries of the specified trailers object.

Parameters:

trailers - the trailers object which contains new values.

Returns:

this.

trailers

public HttpHeaders trailers()

Gets the trailers.

Returns:

the trailers.