Packages

final case class ScpLikeUrl(user: Option[String], host: Host, path: UrlPath)(implicit config: UriConfig = UriConfig.default) extends UrlWithAuthority with Product with Serializable

Represents scp-like URLs, for example: [email protected]:lemonlabsuk/scala-uri.git

From the scp manpage: [user@]host:[path]

Linear Supertypes
UrlWithAuthority, Url, Uri, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScpLikeUrl
  2. UrlWithAuthority
  3. Url
  4. Uri
  5. Serializable
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScpLikeUrl(user: Option[String], host: Host, path: UrlPath)(implicit config: UriConfig = UriConfig.default)

Type Members

  1. type Self = ScpLikeUrl
    Definition Classes
    ScpLikeUrl → UrlWithAuthority → Url → Uri
  2. type SelfWithAuthority = Self
    Definition Classes
    UrlWithAuthority → Url
  3. type SelfWithScheme = AbsoluteUrl
    Definition Classes
    ScpLikeUrl → UrlWithAuthority → Url → Uri

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addParam[K, V](k: K, v: V)(implicit arg0: QueryKey[K], arg1: QueryValue[V]): Self

    Adds a new Query String parameter key-value pair.

    Adds a new Query String parameter key-value pair.

    Pairs with values, such as Some("value"), represent query params with values, i.e ?param=value

    By default, pairs without values, i.e None, represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

    k

    value that provides a name pair for the parameter. Can be a any basic value type or a custom type if you provide a QueryKey type-class

    v

    value that provides a value for the parameter. Can be a any basic value type or a custom type if you provide a QueryValue type-class

    returns

    A new Url with the new Query String parameter

    Definition Classes
    Url
  5. def addParam[A](a: A)(implicit arg0: QueryKeyValue[A]): Self

    Adds a new Query String parameter key-value pair.

    Adds a new Query String parameter key-value pair.

    Pairs with values, such as Some("value"), represent query params with values, i.e ?param=value

    By default, pairs without values, i.e None, represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

    a

    value that provides a name/value pair for the parameter. Can be a Tuple of any basic value types or a custom type if you provide a QueryKeyValue type-class

    returns

    A new Url with the new Query String parameter

    Definition Classes
    Url
  6. def addParams[KV](first: KV, second: KV, params: KV*)(implicit arg0: QueryKeyValue[KV]): Self

    Adds all the specified key-value pairs as parameters to the query

    Adds all the specified key-value pairs as parameters to the query

    params

    A list of key-value pairs to add as query parameters

    returns

    A new Url with the new Query String parameters

    Definition Classes
    Url
  7. def addParams[A](params: A)(implicit arg0: TraversableParams[A]): Self

    Adds all the specified key-value pairs as parameters to the query

    Adds all the specified key-value pairs as parameters to the query

    params

    A list of key-value pairs to add as query parameters

    returns

    A new Url with the new Query String parameters

    Definition Classes
    Url
  8. def addPathPart[P](part: P)(implicit arg0: PathPart[P]): Self
    Definition Classes
    Url
  9. def addPathParts[P](first: P, second: P, parts: P*)(implicit arg0: PathPart[P]): Self
    Definition Classes
    Url
  10. def addPathParts[P](parts: P)(implicit arg0: TraversablePathParts[P]): Self
    Definition Classes
    Url
  11. def apexDomain: Option[String]

    Returns the apex domain for this URL.

    Returns the apex domain for this URL.

    The apex domain is constructed from the public suffix for this URL's host prepended with the immediately preceding dot segment.

    Examples include: example.com for www.example.com example.co.uk for www.example.co.uk

    returns

    the apex domain for this URL

    Definition Classes
    Url
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def authority: Authority
    Definition Classes
    ScpLikeUrl → UrlWithAuthority
  14. def authorityOption: Option[Authority]
    Definition Classes
    UrlWithAuthority → Url
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  16. def collectQuery[KV](f: PartialFunction[(String, Option[String]), KV])(implicit arg0: QueryKeyValue[KV]): Self

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Parameters not defined in the PartialFunction will be removed.

    f

    A function that returns a new Parameter when applied to each Parameter

    Definition Classes
    Url
  17. implicit val config: UriConfig
    Definition Classes
    ScpLikeUrl → Uri
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equalsUnordered(other: Uri): Boolean

    For ScpLikeUrls this method is exactly the same as ==

    For ScpLikeUrls this method is exactly the same as ==

    Definition Classes
    ScpLikeUrl → Url → Uri
  20. def filterQuery(f: ((String, Option[String])) ⇒ Boolean): Self

    Removes any Query String Parameters that return false when applied to the given Function

    Removes any Query String Parameters that return false when applied to the given Function

    Definition Classes
    Url
  21. def filterQueryNames(f: (String) ⇒ Boolean): Self

    Removes any Query String Parameters that return false when their name is applied to the given Function

    Removes any Query String Parameters that return false when their name is applied to the given Function

    Definition Classes
    Url
  22. def filterQueryValues(f: (String) ⇒ Boolean): Self

    Removes any Query String Parameters that return false when their value is applied to the given Function

    Removes any Query String Parameters that return false when their value is applied to the given Function

    Definition Classes
    Url
  23. def flatMapQuery[A](f: ((String, Option[String])) ⇒ A)(implicit arg0: TraversableParams[A]): Self

    Transforms the Query String by applying the specified Function to each Query String Parameter

    Transforms the Query String by applying the specified Function to each Query String Parameter

    f

    A function that returns a collection of Parameters when applied to each parameter

    Definition Classes
    Url
  24. def fragment: Option[String]
    Definition Classes
    ScpLikeUrl → Url
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. val host: Host
    Definition Classes
    ScpLikeUrl → UrlWithAuthority
  27. def hostOption: Option[Host]
    Definition Classes
    UrlWithAuthority → Url
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def longestSubdomain: Option[String]

    Returns the longest subdomain for this URL's host.

    Returns the longest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a.b.c.example

    returns

    the longest subdomain for this URL's host

    Definition Classes
    UrlWithAuthority → Url
  30. def mapPassword(f: (String) ⇒ String): Self

    Transforms this URL by applying the specified Function to the password if it exists

    Transforms this URL by applying the specified Function to the password if it exists

    Definition Classes
    UrlWithAuthority → Url
  31. def mapQuery[KV](f: PartialFunction[(String, Option[String]), KV])(implicit arg0: QueryKeyValue[KV]): Self

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Parameters not defined in the PartialFunction will be left as-is.

    f

    A function that returns a new Parameter when applied to each Parameter

    Definition Classes
    Url
  32. def mapQueryNames[K](f: (String) ⇒ K)(implicit arg0: QueryKey[K]): Self

    Transforms the Query String by applying the specified Function to each Query String Parameter name

    Transforms the Query String by applying the specified Function to each Query String Parameter name

    f

    A function that returns a new Parameter name when applied to each Parameter name

    Definition Classes
    Url
  33. def mapQueryValues[V](f: (String) ⇒ V)(implicit arg0: QueryValue[V]): Self

    Transforms the Query String by applying the specified Function to each Query String Parameter value

    Transforms the Query String by applying the specified Function to each Query String Parameter value

    f

    A function that returns a new Parameter value when applied to each Parameter value

    Definition Classes
    Url
  34. def mapUser(f: (String) ⇒ String): Self

    Transforms this URL by applying the specified Function to the user if it exists

    Transforms this URL by applying the specified Function to the user if it exists

    Definition Classes
    UrlWithAuthority → Url
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def normalize(removeEmptyPathParts: Boolean = false, slashTermination: SlashTermination = SlashTermination.AddForEmptyPath): Self

    Normalizes this

    Normalizes this

    Definition Classes
    ScpLikeUrl → Url
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def password: Option[String]
    Definition Classes
    UrlWithAuthority → Url
  40. val path: UrlPath
    Definition Classes
    ScpLikeUrl → Url → Uri
  41. def port: Option[Int]
    Definition Classes
    UrlWithAuthority → Url
  42. def publicSuffix: Option[String]

    Returns the longest public suffix for the host in this URI.

    Returns the longest public suffix for the host in this URI. Examples include: com for www.example.com co.uk for www.example.co.uk

    returns

    the longest public suffix for the host in this URI

    Definition Classes
    UrlWithAuthority → Url
  43. def publicSuffixes: Vector[String]

    Returns all longest public suffixes for the host in this URI.

    Returns all longest public suffixes for the host in this URI. Examples include: com for www.example.com co.uk and uk for www.example.co.uk

    returns

    all public suffixes for the host in this URI

    Definition Classes
    UrlWithAuthority → Url
  44. def query: QueryString
    Definition Classes
    ScpLikeUrl → Url
  45. def queryToString(config: UriConfig): String
    Attributes
    protected
    Definition Classes
    Url
  46. def removeEmptyPathParts(): Self
    Definition Classes
    Url
  47. def removeParams[K](k: Iterable[K])(implicit arg0: QueryKey[K]): Self

    Removes all Query String parameters with a name in the specified list

    Removes all Query String parameters with a name in the specified list

    k

    Names of Query String parameter(s) to remove

    Definition Classes
    Url
  48. def removeParams[K](first: K, second: K, rest: K*)(implicit arg0: QueryKey[K]): Self

    Removes all Query String parameters with a name in the specified list

    Removes all Query String parameters with a name in the specified list

    first

    Name of a Query String parameter to remove

    second

    Name of another Query String parameter to remove

    rest

    Name of more Query String parameter(s) to remove

    Definition Classes
    Url
  49. def removeParams[K](k: K)(implicit arg0: QueryKey[K]): Self

    Removes all Query String parameters with the specified key

    Removes all Query String parameters with the specified key

    k

    Key for the Query String parameter(s) to remove

    Definition Classes
    Url
  50. def removePassword(): Self

    Removes any password from this URL

    Removes any password from this URL

    returns

    This URL without the password

    Definition Classes
    UrlWithAuthority → Url
  51. def removeQueryString(): Self

    Removes all Query String parameters

    Removes all Query String parameters

    Definition Classes
    Url
  52. def removeUserInfo(): Self

    Removes any user from this URL

    Removes any user from this URL

    returns

    This URL without the user

    Definition Classes
    UrlWithAuthority → Url
  53. def replaceParams[K, V](k: K, v: V)(implicit arg0: QueryKey[K], arg1: QueryValue[V]): Self

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value

    By default, pairs without values, such as ("param", None), represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

    k

    Key for the Query String parameter(s) to replace

    v

    value to replace with

    returns

    A new Uri with the result of the replace

    Definition Classes
    Url
  54. def resolve(base: UrlWithScheme, strict: Boolean = false): UrlWithScheme

    returns

    this URL resolved with the given URL as the base according to section 5.2.2 Transform References of RFC 3986.

    Definition Classes
    Url
  55. def schemeOption: Option[String]
    Definition Classes
    ScpLikeUrl → Uri
  56. def self: ScpLikeUrl
    Definition Classes
    ScpLikeUrl → Uri
  57. def shortestSubdomain: Option[String]

    Returns the shortest subdomain for this URL's host.

    Returns the shortest subdomain for this URL's host. E.g. for http://a.b.c.example.com returns a

    returns

    the shortest subdomain for this URL's host

    Definition Classes
    UrlWithAuthority → Url
  58. def slashTerminated(slashTermination: SlashTermination = SlashTermination.AddForAll): Self
    Definition Classes
    Url
  59. def subdomain: Option[String]

    Returns the second largest subdomain for this URL's host.

    Returns the second largest subdomain for this URL's host.

    E.g. for http://a.b.c.example.com returns a.b.c

    Note: In the event there is only one subdomain (i.e. the host is the apex domain), this method returns None. E.g. This method will return None for http://example.com.

    returns

    the second largest subdomain for this URL's host

    Definition Classes
    UrlWithAuthority → Url
  60. def subdomains: Vector[String]

    Returns all subdomains for this URL's host.

    Returns all subdomains for this URL's host. E.g. for http://a.b.c.example.com returns a, a.b, a.b.c and a.b.c.example

    returns

    all subdomains for this URL's host

    Definition Classes
    UrlWithAuthority → Url
  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def toAbsoluteUrl: AbsoluteUrl
    Definition Classes
    Url
  63. def toJavaURI: URI

    Converts to a java.net.URI

    Converts to a java.net.URI

    This involves a toString and URI.parse because the specific java.net.URI constructors do not deal properly with encoded elements

    returns

    a java.net.URI matching this io.lemonlabs.uri.Uri

    Definition Classes
    Uri
  64. def toProtocolRelativeUrl: ProtocolRelativeUrl
    Definition Classes
    Url
  65. def toRedactedString(redactor: Redactor)(implicit conf: UriConfig = UriConfig.default): String
    Definition Classes
    Url
  66. def toRelativeUrl: RelativeUrl
    Definition Classes
    Url
  67. def toString(): String
    Definition Classes
    Uri → AnyRef → Any
  68. def toStringPunycode: String

    returns

    the URL as a String. If the URI has a domain name for a host, any unicode characters will be returned in ASCII Compatible Encoding (ACE), as defined by the ToASCII operation of RFC 3490.

    Definition Classes
    UrlWithAuthority → Url
  69. def toStringRaw: String

    Returns the path with no encoders taking place (e.g.

    Returns the path with no encoders taking place (e.g. non ASCII characters will not be percent encoded)

    returns

    String containing the raw path for this Uri

    Definition Classes
    Uri
  70. def toUrl: Url
    Definition Classes
    Url → Uri
  71. def toUrn: Urn
    Definition Classes
    Url → Uri
  72. val user: Option[String]
    Definition Classes
    ScpLikeUrl → UrlWithAuthority → Url
  73. def userInfo: Option[UserInfo]
    Definition Classes
    ScpLikeUrl → UrlWithAuthority
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  76. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. def withAuthority(authority: Authority): ScpLikeUrl

    Copies this Url but with the authority set as the given value.

    Copies this Url but with the authority set as the given value.

    authority

    the authority host to set

    returns

    a new Url with the specified authority

    Definition Classes
    ScpLikeUrl → Url
  78. def withFragment[T](fragment: T)(implicit arg0: Fragment[T]): ScpLikeUrl

    Copies this Url but with the fragment set as the given value.

    Copies this Url but with the fragment set as the given value.

    fragment

    the new fragment to set

    returns

    a new Url with the specified fragment

    Definition Classes
    ScpLikeUrl → Url
  79. def withHost(host: Host): Self

    Copies this Url but with the host set as the given value.

    Copies this Url but with the host set as the given value.

    host

    the new host to set

    returns

    a new Url with the specified host

    Definition Classes
    UrlWithAuthority → Url
  80. def withHost(host: String): SelfWithAuthority

    Copies this Url but with the host set as the given value.

    Copies this Url but with the host set as the given value.

    host

    the new host to set

    returns

    a new Url with the specified host

    Definition Classes
    Url
  81. def withPassword(password: String): Self

    Copies this Url but with the password set as the given value.

    Copies this Url but with the password set as the given value.

    password

    the new password to set

    returns

    a new Url with the specified password

    Definition Classes
    UrlWithAuthority
  82. def withPath(path: UrlPath): ScpLikeUrl

    Copies this Url but with the path set as the given value.

    Copies this Url but with the path set as the given value.

    path

    the new path to set

    returns

    a new Url with the specified path

    Definition Classes
    ScpLikeUrl → Url
  83. def withPathParts[P](parts: P)(implicit arg0: TraversablePathParts[P]): Self

    Copies this Url but with the path set as the given value.

    Copies this Url but with the path set as the given value.

    parts

    the parts that make up the new path

    returns

    a new Url with the specified path

    Definition Classes
    Url
  84. def withPort(port: Int): Self

    Copies this Url but with the port set as the given value.

    Copies this Url but with the port set as the given value.

    port

    the new port to set

    returns

    a new Url with the specified port

    Definition Classes
    UrlWithAuthority
  85. def withQueryString(query: QueryString): ScpLikeUrl

    Copies this Url but with the query set as the given value.

    Copies this Url but with the query set as the given value.

    query

    the new QueryString to set

    returns

    a new Url with the specified query

    Definition Classes
    ScpLikeUrl → Url
  86. def withQueryString[KV](first: KV, second: KV, params: KV*)(implicit arg0: QueryKeyValue[KV]): Self

    Replaces the all existing Query String parameters with a new set of query params

    Replaces the all existing Query String parameters with a new set of query params

    Definition Classes
    Url
  87. def withQueryString[T](params: T)(implicit arg0: TraversableParams[T]): Self

    Replaces the all existing Query String parameters with a new set of query params

    Replaces the all existing Query String parameters with a new set of query params

    Definition Classes
    Url
  88. def withScheme(scheme: String): AbsoluteUrl

    Copies this Uri but with the scheme set as the given value.

    Copies this Uri but with the scheme set as the given value.

    scheme

    the new scheme to set

    returns

    a new Uri with the specified scheme

    Definition Classes
    ScpLikeUrl → Uri
  89. def withUser(user: String): Self

    Copies this Url but with the user set as the given value.

    Copies this Url but with the user set as the given value.

    user

    the new user to set

    returns

    a new Url with the specified user

    Definition Classes
    UrlWithAuthority
  90. def withUserInfo(ui: Option[UserInfo]): Self
    Definition Classes
    UrlWithAuthority

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from UrlWithAuthority

Inherited from Url

Inherited from Uri

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped