Module dev.orne.beans

Package dev.orne.beans

Class LongIdentity

java.lang.Object

dev.orne.beans.AbstractIdentity

dev.orne.beans.AbstractSimpleIdentity<Long>

dev.orne.beans.LongIdentity

All Implemented Interfaces:

Identity, Serializable

@API(status=STABLE,
     since="0.1")
public class LongIdentity
extends AbstractSimpleIdentity<Long>

Implementation for Identity for identities composed of a single inner Long value.

Since:

0.1

Version:

1.0, 2020-05

Author:

(w) Iker Hernaez

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LongIdentity(@Nullable Long value)	Creates a new instance.
LongIdentity(LongIdentity copy)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
static Long	extractRequiredTokenValue(String prefix, String token)	Extracts the Long value of a token generated by LongIdentity.
static @Nullable Long	extractTokenValue(String prefix, String token)	Extracts the Long value of a token generated by LongIdentity.
static LongIdentity	fromIdentityToken(String token)	Resolves the specified identity token to a valid LongIdentity.

Methods inherited from class dev.orne.beans.AbstractSimpleIdentity

equals, getIdentityTokenBody, getValue, hashCode

Methods inherited from class dev.orne.beans.AbstractIdentity

getIdentityToken, getIdentityTokenPrefix, parseIdentityTokenBody, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.orne.beans.Identity

resolve

Constructor Details

LongIdentity

@GeneratorMethod
public LongIdentity(@Nullable Long value)

Creates a new instance.

Parameters:

value - The identity value

LongIdentity

public LongIdentity(LongIdentity copy)

Copy constructor.

Parameters:

copy - The instance to copy

Method Details

fromIdentityToken

@IdentityTokenResolver
public static LongIdentity fromIdentityToken(String token)
                                      throws UnrecognizedIdentityTokenException

Resolves the specified identity token to a valid LongIdentity.

Parameters:

token - The identity token

Returns:

The resolved identity token

Throws:

NullPointerException - If the identity token is null

UnrecognizedIdentityTokenException - If the identity token is not a valid identity token or it doesn't start with the expected prefix

extractTokenValue

public static @Nullable Long extractTokenValue(String prefix,
 String token)

Extracts the Long value of a token generated by LongIdentity.

Note that the resulting value can be null. If a non-null value is expected useextractRequiredTokenValue(String, String).

Parameters:

prefix - The expected identity token prefix.

token - The identity token.

Returns:

The extracted Long value.

Throws:

NullPointerException - If the identity token is null

UnrecognizedIdentityTokenException - If the identity token is not a valid simple identity token, if it doesn't start with the expected prefix or if the extracted value is not a valid long.

See Also:

• extractRequiredTokenValue(String, String)

extractRequiredTokenValue

public static Long extractRequiredTokenValue(String prefix,
 String token)

Extracts the Long value of a token generated by LongIdentity.

If the resulting value is null an exception is thrown.

Parameters:

prefix - The expected identity token prefix.

token - The identity token.

Returns:

The extracted Long value.

Throws:

NullPointerException - If the identity token is null

UnrecognizedIdentityTokenException - If the identity token is not a valid simple identity token, if it doesn't start with the expected prefix, if the extracted value is null or if the extracted value is not a valid long.

See Also:

• extractTokenValue(String, String)