Module methanol

Package com.github.mizosoft.methanol.adapter

Class AbstractBodyAdapter

java.lang.Object

com.github.mizosoft.methanol.adapter.AbstractBodyAdapter

All Implemented Interfaces:

BodyAdapter

Direct Known Subclasses:

CharSequenceEncoder, StringDecoder

public abstract class AbstractBodyAdapter
extends Object
implements BodyAdapter

Abstract BodyAdapter that implements BodyAdapter.isCompatibleWith(MediaType) by specifying a set of MediaTypes the adapter is compatible with.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.mizosoft.methanol.BodyAdapter

BodyAdapter.Decoder, BodyAdapter.Encoder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBodyAdapter(MediaType... compatibleMediaTypes)	Creates an AbstractBodyAdapter compatible with the given media types.

Method Summary

Modifier and Type	Method	Description
static HttpRequest.BodyPublisher	attachMediaType(HttpRequest.BodyPublisher publisher, @Nullable MediaType mediaType)	Converts the given publisher into a MimeBodyPublisher only if the given media type is not null or has a wildcard, otherwise the given publisher is returned.
static Charset	charsetOrDefault(@Nullable MediaType mediaType, Charset defaultCharset)	Returns either the result of MediaType.charsetOrDefault(Charset) or defaultCharset directly if mediaType is null.
static Charset	charsetOrUtf8(@Nullable MediaType mediaType)	Returns either the result of MediaType.charsetOrDefault(Charset) or UTF-8 directly if mediaType is null.
protected Set<MediaType>	compatibleMediaTypes()	Returns an immutable set containing the media types this adapter is compatible with.
final boolean	isCompatibleWith(MediaType mediaType)	Returns true if the format this adapter uses is compatible with the given media type.
protected void	requireCompatibleOrNull(@Nullable MediaType mediaType)	Requires that the given media type is either null or is compatible with this adapter.
protected void	requireSupport(TypeRef<?> type)	Requires that the given type is supported by this adapter.
protected void	requireSupport(Class<?> type)	Requires that the given class is supported by this adapter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.mizosoft.methanol.BodyAdapter

supportsType

Constructor Details

AbstractBodyAdapter

protected AbstractBodyAdapter(MediaType... compatibleMediaTypes)

Creates an AbstractBodyAdapter compatible with the given media types.

Method Details

isCompatibleWith

public final boolean isCompatibleWith(MediaType mediaType)

Description copied from interface: BodyAdapter

Returns true if the format this adapter uses is compatible with the given media type.

Specified by:

isCompatibleWith in interface BodyAdapter

compatibleMediaTypes

protected Set<MediaType> compatibleMediaTypes()

Returns an immutable set containing the media types this adapter is compatible with.

requireSupport

protected void requireSupport(TypeRef<?> type)

Requires that the given type is supported by this adapter.

Throws:

UnsupportedOperationException - if this adapter doesn't support the given type.

requireSupport

protected void requireSupport(Class<?> type)

Requires that the given class is supported by this adapter.

Throws:

UnsupportedOperationException - if this adapter doesn't support the given raw type.

requireCompatibleOrNull

protected void requireCompatibleOrNull(@Nullable MediaType mediaType)

Requires that the given media type is either null or is compatible with this adapter.

Throws:

UnsupportedOperationException - if this adapter is not compatible the given type.

charsetOrDefault

public static Charset charsetOrDefault(@Nullable MediaType mediaType,
 Charset defaultCharset)

Returns either the result of MediaType.charsetOrDefault(Charset) or defaultCharset directly if mediaType is null.

charsetOrUtf8

public static Charset charsetOrUtf8(@Nullable MediaType mediaType)

Returns either the result of MediaType.charsetOrDefault(Charset) or UTF-8 directly if mediaType is null.

attachMediaType

public static HttpRequest.BodyPublisher attachMediaType(HttpRequest.BodyPublisher publisher,
 @Nullable MediaType mediaType)

Converts the given publisher into a MimeBodyPublisher only if the given media type is not null or has a wildcard, otherwise the given publisher is returned.