com.edorasware.commons.core.entity

Class UserId

java.lang.Object

com.edorasware.commons.core.id.BaseId

com.edorasware.commons.core.entity.UserId

All Implemented Interfaces:

Id, Serializable

public final class UserId
extends BaseId

This class represents a user id.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static UserId	UNDEFINED A type-safe and null-safe undefined user id.

Fields inherited from class com.edorasware.commons.core.id.BaseId

UNDEFINED_VALUE

Method Summary

Modifier and Type	Method and Description
static UserId	from(Id id) Returns a type-safe user id for the specified id or null if the given id is null.
static UserId	from(Identifiable<?> identifiable) Returns a type-safe user id derived from the id of the specified identifiable or null if the id of the identifiable is null.
static UserId	get(String value) Returns a type-safe user id for the specified value.
static UserId	nullSafeGet(String value) Returns a type-safe user id for the specified value or null if the given value is null.
UserId	withValue(String value) Returns a new user-id with the given value.

Methods inherited from class com.edorasware.commons.core.id.BaseId

equals, getValue, hashCode, isUndefined, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final UserId UNDEFINED

A type-safe and null-safe undefined user id.

Method Detail

withValue

public UserId withValue(String value)

Returns a new user-id with the given value.

Specified by:

withValue in interface Id

Overrides:

withValue in class BaseId

Parameters:

value - the value of the new user id

Returns:

the new user id

get

public static UserId get(String value)

Returns a type-safe user id for the specified value.

Parameters:

value - the value that represents the user id

Returns:

the type-safe user id

nullSafeGet

public static UserId nullSafeGet(String value)

Returns a type-safe user id for the specified value or null if the given value is null.

Parameters:

value - the value that represents the user id or null

Returns:

the type-safe user id or null

from

public static UserId from(Id id)

Returns a type-safe user id for the specified id or null if the given id is null.

Parameters:

id - the id from which to derive the user id

Returns:

the type-safe user id or null

from

public static UserId from(Identifiable<?> identifiable)

Returns a type-safe user id derived from the id of the specified identifiable or null if the id of the identifiable is null.

Parameters:

identifiable - the identifiable whose id is taken to derive the user id

Returns:

the type-safe user id or null