Module methanol

Package com.github.mizosoft.methanol

Class FormBodyPublisher

java.lang.Object

com.github.mizosoft.methanol.FormBodyPublisher

All Implemented Interfaces:

MimeBodyPublisher, HttpRequest.BodyPublisher, Flow.Publisher<ByteBuffer>

public final class FormBodyPublisher
extends Object
implements MimeBodyPublisher

A BodyPublisher for form submission using the application/x-www-form-urlencoded request type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FormBodyPublisher.Builder	A builder of FormBodyPublisher instances.

Method Summary

Modifier and Type	Method	Description
long	contentLength()
String	encodedString()	Returns the url-encoded string of this body's queries.
Optional<String>	firstQuery(String name)	Returns the first value of the query associated with the given key.
Optional<String>	lastQuery(String name)	Returns the last value of the query associated with the given key.
MediaType	mediaType()	Returns the body's media type.
static FormBodyPublisher.Builder	newBuilder()	Returns a new FormBodyPublisher.Builder.
Map<String,List<String>>	queries()	Returns this body's queries.
void	subscribe(Flow.Subscriber<? super ByteBuffer> subscriber)

Methods inherited from class java.lang.Object

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

Method Details

encodedString

public String encodedString()

Returns the url-encoded string of this body's queries.

firstQuery

public Optional<String> firstQuery(String name)

Returns the first value of the query associated with the given key.

Parameters:

name - the query's name

lastQuery

public Optional<String> lastQuery(String name)

Returns the last value of the query associated with the given key.

Parameters:

name - the query's name

queries

public Map<String,List<String>> queries()

Returns this body's queries.

mediaType

public MediaType mediaType()

Description copied from interface: MimeBodyPublisher

Returns the body's media type.

Specified by:

mediaType in interface MimeBodyPublisher

contentLength

public long contentLength()

Specified by:

contentLength in interface HttpRequest.BodyPublisher

subscribe

public void subscribe(Flow.Subscriber<? super ByteBuffer> subscriber)

Specified by:

subscribe in interface Flow.Publisher<ByteBuffer>

newBuilder

public static FormBodyPublisher.Builder newBuilder()

Returns a new FormBodyPublisher.Builder.