Module io.helidon.reactive.media.multipart

Package io.helidon.reactive.media.multipart

Class WriteableBodyPartHeaders

java.lang.Object

io.helidon.reactive.media.multipart.WriteableBodyPartHeaders

All Implemented Interfaces:

Headers, WritableHeaders<WriteableBodyPartHeaders>, BodyPartHeaders, Iterable<Http.HeaderValue>

public final class WriteableBodyPartHeaders
extends Object
implements BodyPartHeaders, WritableHeaders<WriteableBodyPartHeaders>

Writeable body part headers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WriteableBodyPartHeaders.Builder	Builder class to create WriteableBodyPartHeaders instances.

Method Summary

Modifier and Type	Method	Description
List<HttpMediaType>	acceptedTypes()	Returns a list of acceptedTypes (Http.Header.ACCEPT header) content discoveryTypes in quality factor order.
WriteableBodyPartHeaders	add(Http.HeaderValue header)	Add a header or add a header value if the header is already present.
List<String>	all(Http.HeaderName name, Supplier<List<String>> defaultSupplier)	Get all values of a header.
static WriteableBodyPartHeaders.Builder	builder()	Create a new builder instance.
WriteableBodyPartHeaders	clear()	Clear all current headers.
boolean	contains(Http.HeaderName name)	Whether these headers contain a header with the provided name.
boolean	contains(Http.HeaderValue value)	Whether these headers contain a header with the provided name and value.
ContentDisposition	contentDisposition()	Get the Content-Disposition header.
void	contentDisposition(ContentDisposition contentDisposition)	Sets the value of Http.Header.CONTENT_DISPOSITION header.
static WriteableBodyPartHeaders	create()	Create a new instance of WriteableBodyPartHeaders with empty headers.
Http.HeaderValue	get(Http.HeaderName name)	Get a header value.
Iterator<Http.HeaderValue>	iterator()
HttpMediaType	partContentType()	Get the Content-Type header.
WriteableBodyPartHeaders	remove(Http.HeaderName name)	Remove a header.
WriteableBodyPartHeaders	remove(Http.HeaderName name, Consumer<Http.HeaderValue> removedConsumer)	Remove a header.
WriteableBodyPartHeaders	set(Http.HeaderValue header)	Set a header and replace it if it already existed.
WriteableBodyPartHeaders	setIfAbsent(Http.HeaderValue header)	Set a value of a header unless it is already present.
int	size()	Number of headers in these headers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.reactive.media.multipart.BodyPartHeaders

defaultContentType

Methods inherited from interface io.helidon.common.http.Headers

all, contentLength, contentType, first, isAccepted, toMap, value, values

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.helidon.common.http.WritableHeaders

add, contentLength, contentType, contentType, set, set

Method Details

builder

public static WriteableBodyPartHeaders.Builder builder()

Create a new builder instance.

Returns:

Builder

create

public static WriteableBodyPartHeaders create()

Create a new instance of WriteableBodyPartHeaders with empty headers.

Returns:

WriteableBodyPartHeaders

all

public List<String> all(Http.HeaderName name,
 Supplier<List<String>> defaultSupplier)

Description copied from interface: Headers

Get all values of a header.

Specified by:

all in interface Headers

Parameters:

name - name of the header

defaultSupplier - supplier to obtain default values if the header is not present

Returns:

list of header values

contains

public boolean contains(Http.HeaderName name)

Description copied from interface: Headers

Whether these headers contain a header with the provided name.

Specified by:

contains in interface Headers

Parameters:

name - header name

Returns:

true if the header is defined

contains

public boolean contains(Http.HeaderValue value)

Description copied from interface: Headers

Whether these headers contain a header with the provided name and value.

Specified by:

contains in interface Headers

Parameters:

value - value of the header

Returns:

true if the header is defined

get

public Http.HeaderValue get(Http.HeaderName name)

Description copied from interface: Headers

Get a header value.

Specified by:

get in interface Headers

Parameters:

name - name of the header

Returns:

value if present

size

public int size()

Description copied from interface: Headers

Number of headers in these headers.

Specified by:

size in interface Headers

Returns:

size of these headers

acceptedTypes

public List<HttpMediaType> acceptedTypes()

Description copied from interface: Headers

Returns a list of acceptedTypes (Http.Header.ACCEPT header) content discoveryTypes in quality factor order. Never null. Returns an empty list by default.

Specified by:

acceptedTypes in interface Headers

Returns:

A list of acceptedTypes media discoveryTypes.

setIfAbsent

public WriteableBodyPartHeaders setIfAbsent(Http.HeaderValue header)

Description copied from interface: WritableHeaders

Set a value of a header unless it is already present.

Specified by:

setIfAbsent in interface WritableHeaders<WriteableBodyPartHeaders>

Parameters:

header - header with value to set

Returns:

this instance

add

public WriteableBodyPartHeaders add(Http.HeaderValue header)

Description copied from interface: WritableHeaders

Add a header or add a header value if the header is already present.

Specified by:

add in interface WritableHeaders<WriteableBodyPartHeaders>

Parameters:

header - header with value

Returns:

this instance

remove

public WriteableBodyPartHeaders remove(Http.HeaderName name)

Description copied from interface: WritableHeaders

Remove a header.

Specified by:

remove in interface WritableHeaders<WriteableBodyPartHeaders>

Parameters:

name - name of the header to remove

Returns:

this instance

remove

public WriteableBodyPartHeaders remove(Http.HeaderName name,
 Consumer<Http.HeaderValue> removedConsumer)

Description copied from interface: WritableHeaders

Remove a header.

Specified by:

remove in interface WritableHeaders<WriteableBodyPartHeaders>

Parameters:

name - name of the header to remove

removedConsumer - consumer to be called with existing header; if the header did not exist, consumer will not be called

Returns:

this instance

set

public WriteableBodyPartHeaders set(Http.HeaderValue header)

Description copied from interface: WritableHeaders

Set a header and replace it if it already existed.

Specified by:

set in interface WritableHeaders<WriteableBodyPartHeaders>

Parameters:

header - header to set

Returns:

this instance

clear

public WriteableBodyPartHeaders clear()

Description copied from interface: WritableHeaders

Clear all current headers.

Specified by:

clear in interface WritableHeaders<WriteableBodyPartHeaders>

Returns:

this instance

iterator

public Iterator<Http.HeaderValue> iterator()

Specified by:

iterator in interface Iterable<Http.HeaderValue>

partContentType

public HttpMediaType partContentType()

Description copied from interface: BodyPartHeaders

Get the Content-Type header. If the Content-Type header is not present, the default value is retrieved using BodyPartHeaders.defaultContentType().

Specified by:

partContentType in interface BodyPartHeaders

Returns:

HttpMediaType, never null

contentDisposition

public ContentDisposition contentDisposition()

Description copied from interface: BodyPartHeaders

Get the Content-Disposition header.

Specified by:

contentDisposition in interface BodyPartHeaders

Returns:

ContentDisposition, never null

contentDisposition

public void contentDisposition(ContentDisposition contentDisposition)

Sets the value of Http.Header.CONTENT_DISPOSITION header.

Parameters:

contentDisposition - content disposition