it.unibo.alchemist.model.cognitive.impact.individual.Gender.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-cognitive-agents Show documentation

Abstraction for group of pedestrians capable of influence each other emotionally.

There is a newer version: 35.0.0

Show newest version

package it.unibo.alchemist.model.cognitive.impact.individual

/**
 * An enum representing the different genders.
 */
enum class Gender : Characteristic {

    /**
     * Male.
     */
    MALE,

    /**
     * Female.
     */
    FEMALE,
    ;

    /**
     * Factories for [Gender].
     */
    companion object {
        private const val MALE_KEYWORD = "male"
        private const val FEMALE_KEYWORD = "female"

        /**
         * Returns the corresponding gender in this enum given a string resembling it.
         *
         * @param gender
         *          the gender as a string.
         */
        fun fromString(gender: String): Gender = when {
            gender.equals(MALE_KEYWORD, ignoreCase = true) -> MALE
            gender.equals(FEMALE_KEYWORD, ignoreCase = true) -> FEMALE
            else -> throw IllegalArgumentException("$gender is not a valid gender")
        }
    }
}