Package com.linecorp.armeria.common

Interface HttpData

All Superinterfaces:

HttpObject

All Known Subinterfaces:

PooledHttpData

All Known Implementing Classes:

AbstractHttpData, ByteBufHttpData

public interface HttpData
extends HttpObject

HTTP/2 data.

Implementations should generally extend AbstractHttpData to interact with other HttpData implementations.

Method Summary

Modifier and Type	Method	Description
byte[]	array()	Returns the underlying byte array of this data.
static HttpData	copyOf(byte[] data)	Creates a new instance from the specified byte array by first copying it.
static HttpData	copyOf(byte[] data, int offset, int length)	Creates a new instance from the specified byte array, offset and length by first copying it.
static HttpData	copyOf(ByteBuf data)	Creates a new instance from the specified ByteBuf by first copying it's content.
static HttpData	empty()	Returns an empty HttpData.
default boolean	isEmpty()	Returns whether the length() is 0.
int	length()	Returns the length of this data.
static HttpData	of(Charset charset, CharSequence text)	Converts the specified text into an HttpData.
static HttpData	of(Charset charset, String text)	Converts the specified text into an HttpData.
static HttpData	of(Charset charset, String format, Object... args)	Converts the specified formatted string into an HttpData.
static HttpData	ofAscii(CharSequence text)	Converts the specified text into a US-ASCII HttpData.
static HttpData	ofAscii(String text)	Converts the specified text into a US-ASCII HttpData.
static HttpData	ofAscii(String format, Object... args)	Converts the specified formatted string into a US-ASCII HttpData.
static HttpData	ofUtf8(CharSequence text)	Converts the specified text into a UTF-8 HttpData.
static HttpData	ofUtf8(String text)	Converts the specified text into a UTF-8 HttpData.
static HttpData	ofUtf8(String format, Object... args)	Converts the specified formatted string into a UTF-8 HttpData.
default InputStream	toInputStream()	Returns a new InputStream that is sourced from this data.
default Reader	toReader(Charset charset)	Returns a new Reader that is sourced from this data and decoded using the specified Charset.
default Reader	toReaderAscii()	Returns a new Reader that is sourced from this data and decoded using StandardCharsets.US_ASCII.
default Reader	toReaderUtf8()	Returns a new Reader that is sourced from this data and decoded using StandardCharsets.UTF_8.
default String	toString(Charset charset)	Decodes this data into a String.
default String	toStringAscii()	Decodes this data into a String using US-ASCII encoding.
default String	toStringUtf8()	Decodes this data into a String using UTF-8 encoding.
default HttpData	withEndOfStream()	Returns a new HttpData whose HTTP/2 endOfStream flag is set.
HttpData	withEndOfStream(boolean endOfStream)	Returns a new HttpData whose HTTP/2 endOfStream flag is set to endOfStream.
static HttpData	wrap(byte[] data)	Creates a new instance from the specified byte array.
static HttpData	wrap(byte[] data, int offset, int length)	Creates a new instance from the specified byte array, offset and length.
static HttpData	wrap(ByteBuf buf)	Deprecated. Use PooledHttpData.wrap(ByteBuf).

Methods inherited from interface com.linecorp.armeria.common.HttpObject

isEndOfStream

Method Details

empty

static HttpData empty()

Returns an empty HttpData.

wrap

static HttpData wrap(byte[] data)

Creates a new instance from the specified byte array. The array is not copied; any changes made in the array later will be visible to HttpData.

Returns:

a new HttpData. empty() if the length of the specified array is 0.

wrap

static HttpData wrap(byte[] data, int offset, int length)

Creates a new instance from the specified byte array, offset and length. The array is not copied; any changes made in the array later will be visible to HttpData.

Returns:

a new HttpData. empty() if length is 0.

Throws:

ArrayIndexOutOfBoundsException - if offset and length are out of bounds

wrap

@Deprecated static HttpData wrap(ByteBuf buf)

Deprecated.

Use PooledHttpData.wrap(ByteBuf).

Converts the specified Netty ByteBuf into an HttpData. The buffer is not copied; any changes made to it will be visible to HttpData. The ownership of the buffer is transferred to the HttpData. If you still need to use it after calling this method, make sure to call ByteBuf.retain() first.

Returns:

a new HttpData. empty() if the readable bytes of buf is 0.

copyOf

static HttpData copyOf(byte[] data)

Creates a new instance from the specified byte array by first copying it.

Returns:

a new HttpData. empty() if the length of the specified array is 0.

copyOf

static HttpData copyOf(byte[] data, int offset, int length)

Creates a new instance from the specified byte array, offset and length by first copying it.

Returns:

a new HttpData. empty() if length is 0.

Throws:

ArrayIndexOutOfBoundsException - if offset and length are out of bounds

copyOf

static HttpData copyOf(ByteBuf data)

Creates a new instance from the specified ByteBuf by first copying it's content. The reference count of ByteBuf will not be changed.

Returns:

a new HttpData. empty() if the length of the specified array is 0.

of

static HttpData of(Charset charset, CharSequence text)

Converts the specified text into an HttpData.

Parameters:

charset - the Charset to use for encoding text

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

of

static HttpData of(Charset charset, String text)

Converts the specified text into an HttpData.

Parameters:

charset - the Charset to use for encoding text

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

of

static HttpData of(Charset charset, String format, Object... args)

Converts the specified formatted string into an HttpData. The string is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

charset - the Charset to use for encoding string

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

Returns:

a new HttpData. empty() if format is empty.

ofUtf8

static HttpData ofUtf8(CharSequence text)

Converts the specified text into a UTF-8 HttpData.

Parameters:

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

ofUtf8

static HttpData ofUtf8(String text)

Converts the specified text into a UTF-8 HttpData.

Parameters:

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

ofUtf8

static HttpData ofUtf8(String format, Object... args)

Converts the specified formatted string into a UTF-8 HttpData. The string is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

Returns:

a new HttpData. empty() if format is empty.

ofAscii

static HttpData ofAscii(CharSequence text)

Converts the specified text into a US-ASCII HttpData.

Parameters:

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

ofAscii

static HttpData ofAscii(String text)

Converts the specified text into a US-ASCII HttpData.

Parameters:

text - the String to convert

Returns:

a new HttpData. empty() if the length of text is 0.

ofAscii

static HttpData ofAscii(String format, Object... args)

Converts the specified formatted string into a US-ASCII HttpData. The string is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

Returns:

a new HttpData. empty() if format is empty.

array

byte[] array()

Returns the underlying byte array of this data.

length

int length()

Returns the length of this data.

isEmpty

default boolean isEmpty()

Returns whether the length() is 0.

toString

default String toString(Charset charset)

Decodes this data into a String.

Parameters:

charset - the Charset to use for decoding this data

Returns:

the decoded String

toStringUtf8

default String toStringUtf8()

Decodes this data into a String using UTF-8 encoding.

Returns:

the decoded String

toStringAscii

default String toStringAscii()

Decodes this data into a String using US-ASCII encoding.

Returns:

the decoded String

toInputStream

default InputStream toInputStream()

Returns a new InputStream that is sourced from this data.

toReader

default Reader toReader(Charset charset)

Returns a new Reader that is sourced from this data and decoded using the specified Charset.

toReaderUtf8

default Reader toReaderUtf8()

Returns a new Reader that is sourced from this data and decoded using StandardCharsets.UTF_8.

toReaderAscii

default Reader toReaderAscii()

Returns a new Reader that is sourced from this data and decoded using StandardCharsets.US_ASCII.

withEndOfStream

default HttpData withEndOfStream()

Returns a new HttpData whose HTTP/2 endOfStream flag is set.

withEndOfStream

HttpData withEndOfStream(boolean endOfStream)

Returns a new HttpData whose HTTP/2 endOfStream flag is set to endOfStream.