commonMain.dk.cachet.carp.common.domain.users.Account.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carp.common

Helper classes and base types relied upon by all subsystems. This library does not contain any domain logic.

The newest version!

package dk.cachet.carp.common.domain.users

import dk.cachet.carp.common.application.EmailAddress
import dk.cachet.carp.common.application.UUID
import dk.cachet.carp.common.application.users.AccountIdentity
import dk.cachet.carp.common.application.users.EmailAccountIdentity
import dk.cachet.carp.common.application.users.Username
import dk.cachet.carp.common.application.users.UsernameAccountIdentity
import kotlinx.serialization.*


/**
 * Uniquely identifies an account and its associated identity.
 */
@Serializable
data class Account(
    /**
     * Identity associated with this account.
     */
    val identity: AccountIdentity,
    val id: UUID = UUID.randomUUID()
)
{
    companion object
    {
        /**
         * Create a new [Account] uniquely identified by the specified [emailAddress].
         */
        fun withEmailIdentity( emailAddress: String ): Account =
            Account( EmailAccountIdentity( emailAddress ) )

        /**
         * Create a new [Account] uniquely identified by the specified [emailAddress].
         */
        fun withEmailIdentity( emailAddress: EmailAddress ): Account =
            Account( EmailAccountIdentity( emailAddress ) )

        /**
         * Create a new [Account] uniquely identified by the specified [username].
         */
        fun withUsernameIdentity( username: String ): Account =
            Account( UsernameAccountIdentity( username ) )

        /**
         * Create a new [Account] uniquely identified by the specified [username].
         */
        fun withUsernameIdentity( username: Username ): Account =
            Account( UsernameAccountIdentity( username ) )
    }

    /**
     * Determines whether this account has the same [identity] as [otherAccount].
     */
    fun hasSameIdentity( otherAccount: Account ): Boolean =
        identity == otherAccount.identity
}