com.edorasware.commons.core.entity

Class TenantId

java.lang.Object

com.edorasware.commons.core.id.BaseId

com.edorasware.commons.core.entity.TenantId

All Implemented Interfaces:

Id, Serializable

public final class TenantId
extends BaseId

This class represents a tenant id.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TenantId	UNDEFINED A type-safe and null-safe undefined tenant id.

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

UNDEFINED_VALUE

Method Summary

Modifier and Type	Method and Description
static TenantId	from(Id id) Returns a type-safe tenant id for the specified id or null if the given id is null.
static TenantId	from(Identifiable<?> identifiable) Returns a type-safe tenant id derived from the id of the specified identifiable or null if the id of the identifiable is null.
static TenantId	get(String value) Returns a type-safe tenant id for the specified value.
static TenantId	nullSafeGet(String value) Returns a type-safe tenant id for the specified value or null if the given value is null.
TenantId	withValue(String value) Returns a new tenant-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 TenantId UNDEFINED

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

Method Detail

withValue

public TenantId withValue(String value)

Returns a new tenant-id with the given value.

Specified by:

withValue in interface Id

Overrides:

withValue in class BaseId

Parameters:

value - the value of the new tenant id

Returns:

the new tenant id

get

public static TenantId get(String value)

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

Parameters:

value - the value that represents the tenant id

Returns:

the type-safe tenant id

nullSafeGet

public static TenantId nullSafeGet(String value)

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

Parameters:

value - the value that represents the tenant id or null

Returns:

the type-safe tenant id or null

from

public static TenantId from(Id id)

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

Parameters:

id - the id from which to derive the tenant id

Returns:

the type-safe tenant id or null

from

public static TenantId from(Identifiable<?> identifiable)

Returns a type-safe tenant 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 tenant id

Returns:

the type-safe tenant id or null