org.apache.pekko.http.scaladsl.common

Class NameReceptacle<T>

java.lang.Object

org.apache.pekko.http.scaladsl.common.NameReceptacle<T>

public class NameReceptacle<T>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NameReceptacle(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
<B> NameReceptacle<B>	as() Extract the value as the specified type.
<B> NameUnmarshallerReceptacle<B>	as(Unmarshaller<T,B> unmarshaller, Unmarshaller<java.lang.String,T> fsu) Extract the value as the specified type with the given pekko.http.scaladsl.unmarshalling.Unmarshaller.
java.lang.String	name()
NameOptionReceptacle<T>	optional() Extract the optional value as Option[String].
RepeatedValueReceptacle<T>	repeated() Extract multiple occurrences as Iterable[String].
<B> RequiredValueReceptacle<B>	requiredValue(B requiredValue) Require the given value and extract nothing.
<B> NameDefaultReceptacle<B>	withDefault(B default_) Extract the optional value as String, 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 Detail

NameReceptacle

public NameReceptacle(java.lang.String name)

Method Detail

as

public <B> NameReceptacle<B> as()

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

Returns:

(undocumented)

as

public <B> NameUnmarshallerReceptacle<B> as(Unmarshaller<T,B> unmarshaller,
                                            Unmarshaller<java.lang.String,T> fsu)

Extract the value as the specified type with the given pekko.http.scaladsl.unmarshalling.Unmarshaller.

Parameters:

unmarshaller - (undocumented)

fsu - (undocumented)

Returns:

(undocumented)

name

public java.lang.String name()

optional

public NameOptionReceptacle<T> optional()

Extract the optional value as Option[String].

Returns:

(undocumented)

repeated

public RepeatedValueReceptacle<T> repeated()

Extract multiple occurrences as Iterable[String].

Returns:

(undocumented)

requiredValue

public <B> RequiredValueReceptacle<B> requiredValue(B requiredValue)

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

Parameters:

requiredValue - (undocumented)

Returns:

(undocumented)

withDefault

public <B> NameDefaultReceptacle<B> withDefault(B default_)

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

Parameters:

default_ - (undocumented)

Returns:

(undocumented)