Module com.github.f4b6a3.uuid

Package com.github.f4b6a3.uuid.codec

Class UriCodec

java.lang.Object

com.github.f4b6a3.uuid.codec.UriCodec

All Implemented Interfaces:

UuidCodec<URI>

public class UriCodec
extends Object
implements UuidCodec<URI>

Codec for UUID URIs (specifically URNs).

UriCodec encodes UUID to and from an opaque URI.

The URN representation adds the prefix 'urn:uuid:' to a UUID canonical representation. See: https://github.com/f4b6a3/uuid-creator/issues/32 * @see InvalidUuidException

See Also:

UUID URIs, UriCodec.isUuidUrn(java.net.URI uri), What is the difference between URI, URL and URN?

Field Summary

Fields

Modifier and Type	Field	Description
static UriCodec	INSTANCE	A shared immutable instance.

Constructor Summary

Constructors

Constructor	Description
UriCodec()

Method Summary

Modifier and Type	Method	Description
UUID	decode(URI uri)	Get a UUID from a URI.
URI	encode(UUID uuid)	Get a URI from a UUID.
static boolean	isUuidUri(URI uri)	Check if the URI is a UUID URN.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final UriCodec INSTANCE

A shared immutable instance.

Constructor Detail

UriCodec

public UriCodec()

Method Detail

encode

public URI encode(UUID uuid)

Get a URI from a UUID.

Specified by:

encode in interface UuidCodec<URI>

Parameters:

uuid - a UUID

Returns:

a URI

Throws:

InvalidUuidException - if the argument is invalid

decode

public UUID decode(URI uri)

Get a UUID from a URI.

Specified by:

decode in interface UuidCodec<URI>

Parameters:

uri - a URI

Returns:

a UUID

Throws:

InvalidUuidException - if the argument is invalid

isUuidUri

public static boolean isUuidUri(URI uri)

Check if the URI is a UUID URN.

Parameters:

uri - a URI

Returns:

true if the it's a URN