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:

BasicAdapter

public abstract class AbstractBodyAdapter
extends java.lang.Object
implements BodyAdapter

An abstract BodyAdapter that implements BodyAdapter.isCompatibleWith(MediaType) by allowing subclasses to specify a set of MediaTypes the adapter is compatible with.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractBodyAdapter.BaseDecoder	This interface abstracts the more-capable AbstractBodyAdapter.BaseDecoder.toObject(TypeRef, Hints) method and adds a default implementation for AbstractBodyAdapter.BaseDecoder.toObject(TypeRef, MediaType) that forwards to the former.
static interface	AbstractBodyAdapter.BaseEncoder	This interface abstracts the more-capable AbstractBodyAdapter.BaseEncoder.toBody(Object, TypeRef, Hints) method and adds a default implementation for AbstractBodyAdapter.BaseEncoder.toBody(Object, MediaType) that forwards to the former.

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

BodyAdapter.Decoder, BodyAdapter.Encoder, BodyAdapter.Hints

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 java.net.http.HttpRequest.BodyPublisher	attachMediaType(java.net.http.HttpRequest.BodyPublisher publisher, @Nullable MediaType mediaType)	Converts the given publisher into a MimeBodyPublisher that has the given media type only if it is not null or has a wildcard, otherwise the given publisher is returned as-is.
static java.nio.charset.Charset	charsetOrDefault(@Nullable MediaType mediaType, java.nio.charset.Charset defaultCharset)	Returns either the result of MediaType.charsetOrDefault(Charset), or the given charset if the given media type is null.
static java.nio.charset.Charset	charsetOrUtf8(@Nullable MediaType mediaType)	Returns either the result of MediaType.charsetOrDefault(Charset), or UTF-8 if the given media type is null.
protected java.util.Set<MediaType>	compatibleMediaTypes()	Returns an immutable set containing the media types this adapter is compatible with.
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 either this adapter is compatible with the given media type, or the given media type is null.
protected void	requireSupport(TypeRef<?> typeRef)	Requires that this adapter supports the given type.
protected void	requireSupport(TypeRef<?> typeRef, BodyAdapter.Hints hints)	Requires that this adapter supports the given type and is compatible with the given hints' media type, if any.
protected void	requireSupport(java.lang.Class<?> type)	Requires that this adapter supports the given type.

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 Detail

AbstractBodyAdapter

protected AbstractBodyAdapter(MediaType... compatibleMediaTypes)

Creates an AbstractBodyAdapter compatible with the given media types.

Method Detail

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 java.util.Set<MediaType> compatibleMediaTypes()

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

requireSupport

protected void requireSupport(TypeRef<?> typeRef)

Requires that this adapter supports the given type.

Throws:

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

requireSupport

protected void requireSupport(java.lang.Class<?> type)

Requires that this adapter supports the given type.

Throws:

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

requireSupport

protected void requireSupport(TypeRef<?> typeRef,
                              BodyAdapter.Hints hints)

Requires that this adapter supports the given type and is compatible with the given hints' media type, if any.

Throws:

java.lang.UnsupportedOperationException - if this adapter doesn't support the given type or is not compatible with the given hints' media type.

requireCompatibleOrNull

protected void requireCompatibleOrNull(@Nullable MediaType mediaType)

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

Throws:

java.lang.UnsupportedOperationException - if this adapter is not compatible with the given media type.

charsetOrDefault

public static java.nio.charset.Charset charsetOrDefault(@Nullable MediaType mediaType,
                                                        java.nio.charset.Charset defaultCharset)

Returns either the result of MediaType.charsetOrDefault(Charset), or the given charset if the given media type is null.

charsetOrUtf8

public static java.nio.charset.Charset charsetOrUtf8(@Nullable MediaType mediaType)

Returns either the result of MediaType.charsetOrDefault(Charset), or UTF-8 if the given media type is null.

attachMediaType

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

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