Module com.github.f4b6a3.uuid

Package com.github.f4b6a3.uuid.codec

Class UrnCodec

java.lang.Object

com.github.f4b6a3.uuid.codec.UrnCodec

All Implemented Interfaces:

UuidCodec<String>

public class UrnCodec
extends Object
implements UuidCodec<String>

Codec for UUID URNs.

UrnCodec encodes UUID to and from an URN.

The URN representation adds the prefix 'urn:uuid:' to a UUID canonical representation.

See Also:

InvalidUuidException, 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 UrnCodec	INSTANCE	A shared immutable instance.

Constructor Summary

Constructors

Constructor	Description
UrnCodec()

Method Summary

Modifier and Type	Method	Description
UUID	decode(String urn)	Get a UUID from a URN string.
String	encode(UUID uuid)	Get a URN string from a UUID.
static boolean	isUuidUrn(String urn)	Check if a URN string 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 UrnCodec INSTANCE

A shared immutable instance.

Constructor Detail

UrnCodec

public UrnCodec()

Method Detail

encode

public String encode(UUID uuid)

Get a URN string from a UUID.

Specified by:

encode in interface UuidCodec<String>

Parameters:

uuid - a UUID

Returns:

a URN string

Throws:

InvalidUuidException - if the argument is invalid

decode

public UUID decode(String urn)

Get a UUID from a URN string.

Specified by:

decode in interface UuidCodec<String>

Parameters:

urn - a URN string

Returns:

a UUID

Throws:

InvalidUuidException - if the argument is invalid

isUuidUrn

public static boolean isUuidUrn(String urn)

Check if a URN string is a UUID URN.

Parameters:

urn - a string

Returns:

true if the it's a URN