Class NameReceptacle<T>

java.lang.Object
akka.http.scaladsl.common.NameReceptacle<T>

public class NameReceptacle<T> extends Object
  • Constructor Details

    • NameReceptacle

      public NameReceptacle(String name)
  • Method Details

    • as

      public <B> NameReceptacle<B> as()
      Extract the value as the specified type. You need a matching Unmarshaller in scope for that to work.
      Returns:
      (undocumented)
    • as

      public <B> NameUnmarshallerReceptacle<B> as(Unmarshaller<T,B> unmarshaller, Unmarshaller<String,T> fsu)
      Extract the value as the specified type with the given Unmarshaller.
      Parameters:
      unmarshaller - (undocumented)
      fsu - (undocumented)
      Returns:
      (undocumented)
    • name

      public 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)