Package akka.http.scaladsl.common

Class NameUnmarshallerReceptacle<T>

java.lang.Object

akka.http.scaladsl.common.NameUnmarshallerReceptacle<T>

public class NameUnmarshallerReceptacle<T>
extends Object

Constructor Summary

Constructors

Constructor	Description
NameUnmarshallerReceptacle(String name, Unmarshaller<String,T> um)

Method Summary

Modifier and Type	Method	Description
<B> NameUnmarshallerReceptacle<B>	as(Unmarshaller<T,B> unmarshaller)	Extract the value as the specified type.
String	name()
NameOptionUnmarshallerReceptacle<T>	optional()	Extract the optional value as Option[T].
RepeatedValueUnmarshallerReceptacle<T>	repeated()	Extract multiple occurrences as Iterable[String].
RequiredValueUnmarshallerReceptacle<T>	requiredValue(T requiredValue)	Require the given value and extract nothing.
Unmarshaller<String,T>	um()
NameDefaultUnmarshallerReceptacle<T>	withDefault(T default_)	Extract the optional value as T, if it is missing use the given default value.

Methods inherited from class java.lang.Object

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

Constructor Details

NameUnmarshallerReceptacle

public NameUnmarshallerReceptacle(String name,
 Unmarshaller<String,T> um)

Method Details

as

public <B> NameUnmarshallerReceptacle<B> as(Unmarshaller<T,B> unmarshaller)

Extract the value as the specified type. You need a matching Unmarshaller in scope for that to work.

Parameters:

unmarshaller - (undocumented)

Returns:

(undocumented)

name

public String name()

optional

public NameOptionUnmarshallerReceptacle<T> optional()

Extract the optional value as Option[T]. Symbolic alias for optional().

Returns:

(undocumented)

repeated

public RepeatedValueUnmarshallerReceptacle<T> repeated()

Extract multiple occurrences as Iterable[String].

Returns:

(undocumented)

requiredValue

public RequiredValueUnmarshallerReceptacle<T> requiredValue(T requiredValue)

Require the given value and extract nothing. Reject if it is missing or has a different value.

Parameters:

requiredValue - (undocumented)

Returns:

(undocumented)

um

public Unmarshaller<String,T> um()

withDefault

public NameDefaultUnmarshallerReceptacle<T> withDefault(T default_)

Extract the optional value as T, if it is missing use the given default value.

Parameters:

default_ - (undocumented)

Returns:

(undocumented)