app/io.schiar.fridgnet.model/AdministrativeLevel

AdministrativeLevel

enum AdministrativeLevel : Enum<AdministrativeLevel>

Represents the administrative level of an AdministrativeUnit, using a simplified format common in countries like the USA.

Note: This simplification might not be suitable for all countries with different administrative structures.

Entries

Represents a city or a town.

Represents a county or a similar sub-administrative area.

Represents a state or a province.

Represents a country.

Properties

administrativeUnitSize

val administrativeUnitSize: Int

val entries: EnumEntries<AdministrativeLevel>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

val zIndex: Float

Functions

toAdministrativeUnitLevelViewData

fun AdministrativeLevel.toAdministrativeUnitLevelViewData(): AdministrativeLevelViewData

Converts the AdministrativeLevel model into the view object AdministrativeLevelViewData used to represent administrative units in the UI.

fun valueOf(value: String): AdministrativeLevel

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<AdministrativeLevel>

Returns an array containing the constants of this enum type, in the order they're declared.

fun with(administrativeUnitName: AdministrativeUnitName): String

The name of an administrative unit considering its administrativeLevel. This method is used to disambiguate some administration units that are the same name.