com.github.mizool.core

Class UrlRef

java.lang.Object

com.github.mizool.core.UrlRef

public final class UrlRef
extends Object

Safely stores a reference to a URL and allows conversion to URI and URL at any time.

Features

• Unlike URL, this class ensures that invocations of equals() and hashCode() never trigger network requests, making this class suitable for collections. For details, see the SonarQube rule "URL.hashCode" and "URL.equals" should be avoided.
• When constructing a UrlRef instance, it is ensured that it later can be converted to both a URI and a URL.
• Creating a UrlRef never throws checked exceptions.
• Unlike URI, an UrlRef instance can be used to build a child URI - just like URL with its two-arg constructor.

Constructor Summary

Constructors

Constructor and Description
UrlRef(@NonNull String spec)
UrlRef(@NonNull URI uri)
UrlRef(@NonNull URL url)

Method Summary

Modifier and Type	Method and Description
UrlRef	resolve(@NonNull String spec) Creates a new UrlRef by combining the URL referenced by this instance (the "context") with the given spec.
String	toString()
URI	toUri()
URL	toUrl()

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlRef

public UrlRef(@NonNull
              @NonNull URI uri)

Throws:

NullPointerException - if uri is null

IllegalArgumentException - if the resulting UrlRef would cause exceptions when converted to URL

UrlRef

public UrlRef(@NonNull
              @NonNull URL url)

Throws:

NullPointerException - if url is null

IllegalArgumentException - if the resulting UrlRef would cause exceptions when converted to URI

UrlRef

public UrlRef(@NonNull
              @NonNull String spec)

Throws:

NullPointerException - if spec is null

IllegalArgumentException - if the resulting UrlRef would cause exceptions when converted to URI or URL

Method Detail

resolve

public UrlRef resolve(@NonNull
                      @NonNull String spec)

Creates a new UrlRef by combining the URL referenced by this instance (the "context") with the given spec.

The new URL is constructed as if using URL.URL(URL, String). Note that the result differs based on whether the context has a trailing slash, the spec has a leading slash, both, or none.

Throws:

NullPointerException - if spec is null

IllegalArgumentException - if the resulting UrlRef would cause exceptions when converted to URI or URL

toUri

public URI toUri()

toUrl

public URL toUrl()

toString

public String toString()

Overrides:

toString in class Object