Package org.apache.pekko.http.javadsl.unmarshalling

Class Unmarshaller<A,B>

java.lang.Object

org.apache.pekko.http.javadsl.unmarshalling.Unmarshaller<A,B>

All Implemented Interfaces:

UnmarshallerBase<A,B>

public abstract class Unmarshaller<A,B>
extends Object
implements UnmarshallerBase<A,B>

An unmarshaller transforms values of type A into type B.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Unmarshaller.UnsupportedContentTypeException

Constructor Summary

Constructors

Constructor	Description
Unmarshaller()

Method Summary

Modifier and Type	Method	Description
abstract Unmarshaller<A,B>	asScala()
<I> Unmarshaller<I,B>	asScalaCastInput()	INTERNAL API
static <A, B> Unmarshaller<A,B>	async(Function<A,CompletionStage<B>> f)	Creates an unmarshaller from an asynchronous Java function.
static Unmarshaller<HttpEntity,byte[]>	entityToByteArray()
static Unmarshaller<HttpEntity,org.apache.pekko.util.ByteString>	entityToByteString()
static Unmarshaller<HttpEntity,char[]>	entityToCharArray()
static Unmarshaller<HttpEntity,Multipart.ByteRanges>	entityToMultipartByteRangesUnmarshaller()
static Unmarshaller<HttpEntity,Multipart.FormData>	entityToMultipartFormData()
static Unmarshaller<HttpEntity,String>	entityToString()
static Unmarshaller<HttpEntity,FormData>	entityToWwwUrlEncodedFormData()
static <A, B> Unmarshaller<A,B>	firstOf(Unmarshaller<A,B> u1, Unmarshaller<A,B> u2)
static <A, B> Unmarshaller<A,B>	firstOf(Unmarshaller<A,B> u1, Unmarshaller<A,B> u2, Unmarshaller<A,B> u3)
static <A, B> Unmarshaller<A,B>	firstOf(Unmarshaller<A,B> u1, Unmarshaller<A,B> u2, Unmarshaller<A,B> u3, Unmarshaller<A,B> u4)
static <A, B> Unmarshaller<A,B>	firstOf(Unmarshaller<A,B> u1, Unmarshaller<A,B> u2, Unmarshaller<A,B> u3, Unmarshaller<A,B> u4, Unmarshaller<A,B> u5)
<C> Unmarshaller<A,C>	flatMap(Function<B,CompletionStage<C>> f)
<C> Unmarshaller<A,C>	flatMap(Unmarshaller<? super B,C> u)
static <B> Unmarshaller<HttpEntity,B>	forMediaType(MediaType t, Unmarshaller<HttpEntity,B> um)
static <B> Unmarshaller<HttpEntity,B>	forMediaTypes(Iterable<MediaType> types, Unmarshaller<HttpEntity,B> um)
static <A, B> Unmarshaller<A,B>	fromScala(Unmarshaller<A,B> scalaUnmarshaller)
static Unmarshaller<HttpRequest,RequestEntity>	requestToEntity()
static <A, B> Unmarshaller<A,B>	sync(Function<A,B> f)	Creates an unmarshaller from a Java function.
<C> Unmarshaller<A,C>	thenApply(Function<B,C> f)	Transform the result B of this unmarshaller to a C producing a marshaller that turns As into Cs
CompletionStage<B>	unmarshal(A value, org.apache.pekko.actor.ClassicActorSystemProvider system)	Apply this Unmarshaller to the given value.
CompletionStage<B>	unmarshal(A value, org.apache.pekko.stream.Materializer mat)	Apply this Unmarshaller to the given value.
CompletionStage<B>	unmarshal(A value, scala.concurrent.ExecutionContext ec, org.apache.pekko.actor.ClassicActorSystemProvider system)	Apply this Unmarshaller to the given value.
CompletionStage<B>	unmarshal(A value, scala.concurrent.ExecutionContext ec, org.apache.pekko.stream.Materializer mat)	Apply this Unmarshaller to the given value.

Methods inherited from class java.lang.Object

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

Constructor Details

Unmarshaller

public Unmarshaller()

Method Details

fromScala

public static <A,
B> Unmarshaller<A,B> fromScala(Unmarshaller<A,B> scalaUnmarshaller)

async

public static <A,
B> Unmarshaller<A,B> async(Function<A,CompletionStage<B>> f)

Creates an unmarshaller from an asynchronous Java function.

Parameters:

f - (undocumented)

Returns:

(undocumented)

sync

public static <A,
B> Unmarshaller<A,B> sync(Function<A,B> f)

Creates an unmarshaller from a Java function.

Parameters:

f - (undocumented)

Returns:

(undocumented)

entityToByteString

public static Unmarshaller<HttpEntity,org.apache.pekko.util.ByteString> entityToByteString()

entityToByteArray

public static Unmarshaller<HttpEntity,byte[]> entityToByteArray()

entityToCharArray

public static Unmarshaller<HttpEntity,char[]> entityToCharArray()

entityToString

public static Unmarshaller<HttpEntity,String> entityToString()

entityToWwwUrlEncodedFormData

public static Unmarshaller<HttpEntity,FormData> entityToWwwUrlEncodedFormData()

entityToMultipartByteRangesUnmarshaller

public static Unmarshaller<HttpEntity,Multipart.ByteRanges> entityToMultipartByteRangesUnmarshaller()

entityToMultipartFormData

public static Unmarshaller<HttpEntity,Multipart.FormData> entityToMultipartFormData()

requestToEntity

public static Unmarshaller<HttpRequest,RequestEntity> requestToEntity()

forMediaType

public static <B> Unmarshaller<HttpEntity,B> forMediaType(MediaType t,
 Unmarshaller<HttpEntity,B> um)

forMediaTypes

public static <B> Unmarshaller<HttpEntity,B> forMediaTypes(Iterable<MediaType> types,
 Unmarshaller<HttpEntity,B> um)

firstOf

public static <A,
B> Unmarshaller<A,B> firstOf(Unmarshaller<A,B> u1,
 Unmarshaller<A,B> u2)

firstOf

public static <A,
B> Unmarshaller<A,B> firstOf(Unmarshaller<A,B> u1,
 Unmarshaller<A,B> u2,
 Unmarshaller<A,B> u3)

firstOf

public static <A,
B> Unmarshaller<A,B> firstOf(Unmarshaller<A,B> u1,
 Unmarshaller<A,B> u2,
 Unmarshaller<A,B> u3,
 Unmarshaller<A,B> u4)

firstOf

public static <A,
B> Unmarshaller<A,B> firstOf(Unmarshaller<A,B> u1,
 Unmarshaller<A,B> u2,
 Unmarshaller<A,B> u3,
 Unmarshaller<A,B> u4,
 Unmarshaller<A,B> u5)

asScala

public abstract Unmarshaller<A,B> asScala()

asScalaCastInput

public <I> Unmarshaller<I,B> asScalaCastInput()

INTERNAL API

unmarshal

public CompletionStage<B> unmarshal(A value,
 scala.concurrent.ExecutionContext ec,
 org.apache.pekko.stream.Materializer mat)

Apply this Unmarshaller to the given value.

Parameters:

value - (undocumented)

ec - (undocumented)

mat - (undocumented)

Returns:

(undocumented)

unmarshal

public CompletionStage<B> unmarshal(A value,
 org.apache.pekko.stream.Materializer mat)

Apply this Unmarshaller to the given value. Uses the default materializer ExecutionContext. If you expect the marshalling to be heavy, it is suggested to provide a specialized context for those operations.

Parameters:

value - (undocumented)

mat - (undocumented)

Returns:

(undocumented)

unmarshal

public CompletionStage<B> unmarshal(A value,
 scala.concurrent.ExecutionContext ec,
 org.apache.pekko.actor.ClassicActorSystemProvider system)

Apply this Unmarshaller to the given value.

Parameters:

value - (undocumented)

ec - (undocumented)

system - (undocumented)

Returns:

(undocumented)

unmarshal

public CompletionStage<B> unmarshal(A value,
 org.apache.pekko.actor.ClassicActorSystemProvider system)

Apply this Unmarshaller to the given value. Uses the default materializer ExecutionContext. If you expect the marshalling to be heavy, it is suggested to provide a specialized context for those operations.

Parameters:

value - (undocumented)

system - (undocumented)

Returns:

(undocumented)

thenApply

public <C> Unmarshaller<A,C> thenApply(Function<B,C> f)

Transform the result B of this unmarshaller to a C producing a marshaller that turns As into Cs

Parameters:

f - (undocumented)

Returns:

A new marshaller that can unmarshall instances of A into instances of C

flatMap

public <C> Unmarshaller<A,C> flatMap(Function<B,CompletionStage<C>> f)

flatMap

public <C> Unmarshaller<A,C> flatMap(Unmarshaller<? super B,C> u)