Packages

final case class UriTemplate(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: Path = Nil, query: UriTemplate.Query = Nil, fragment: Fragment = Nil) extends Product with Serializable

Simple representation of a URI Template that can be rendered as RFC6570 conform string.

This model reflects only a subset of RFC6570.

Level 1 and Level 2 are completely modeled and Level 3 features are limited to:

  • Path segments, slash-prefixed
  • Form-style query, ampersand-separated
  • Fragment expansion
Source
UriTemplate.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UriTemplate
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UriTemplate(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: Path = Nil, query: UriTemplate.Query = Nil, fragment: Fragment = Nil)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UriTemplate to any2stringadd[UriTemplate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UriTemplate, B)
    Implicit
    This member is added by an implicit conversion from UriTemplate to ArrowAssoc[UriTemplate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val authority: Option[Authority]
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def ensuring(cond: (UriTemplate) ⇒ Boolean, msg: ⇒ Any): UriTemplate
    Implicit
    This member is added by an implicit conversion from UriTemplate to Ensuring[UriTemplate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (UriTemplate) ⇒ Boolean): UriTemplate
    Implicit
    This member is added by an implicit conversion from UriTemplate to Ensuring[UriTemplate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): UriTemplate
    Implicit
    This member is added by an implicit conversion from UriTemplate to Ensuring[UriTemplate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): UriTemplate
    Implicit
    This member is added by an implicit conversion from UriTemplate to Ensuring[UriTemplate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def expandAny[T](name: String, value: T)(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type that matches the given name.

    Replaces any expansion type that matches the given name. If no matching expansion could be found the same instance will be returned.

  15. def expandFragment[T](name: String, value: T)(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type in fragment that matches the given name.

    Replaces any expansion type in fragment that matches the given name. If no matching expansion could be found the same instance will be returned.

  16. def expandPath[T](name: String, value: T)(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type in path that matches the given name.

    Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

  17. def expandPath[T](name: String, values: List[T])(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type in path that matches the given name.

    Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

  18. def expandQuery[T](name: String, values: T*)(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type in query that matches the specified name.

    Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

  19. def expandQuery(name: String): UriTemplate

    Replaces any expansion type in query that matches the specified name.

    Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

  20. def expandQuery[T](name: String, values: List[T])(implicit arg0: QueryParamEncoder[T]): UriTemplate

    Replaces any expansion type in query that matches the specified name.

    Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UriTemplate to StringFormat[UriTemplate] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. val fragment: Fragment
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val path: Path
  30. val query: UriTemplate.Query
  31. val scheme: Option[Scheme]
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. lazy val toString: String
  34. def toUriIfPossible: Try[Uri]

    If no expansion is available an Uri will be created otherwise the current instance of UriTemplate will be returned.

  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  38. def [B](y: B): (UriTemplate, B)
    Implicit
    This member is added by an implicit conversion from UriTemplate to ArrowAssoc[UriTemplate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UriTemplate to any2stringadd[UriTemplate]

Inherited by implicit conversion StringFormat from UriTemplate to StringFormat[UriTemplate]

Inherited by implicit conversion Ensuring from UriTemplate to Ensuring[UriTemplate]

Inherited by implicit conversion ArrowAssoc from UriTemplate to ArrowAssoc[UriTemplate]

Ungrouped