IndoorLevel

  • IndoorLevel represents a level within a building, and levels are uniquely identified by their IDs, not content.

  • A level can belong to multiple buildings (e.g., a parking level spanning across buildings).

  • IndoorLevel provides methods to get the localized display name and short name of the level.

  • The activate() method sets the level as visible within its associated building(s).

  • IndoorLevel objects are compared for equality based on their IDs using the equals() method.
public final class IndoorLevel extends Object

Represents a level in a building.

IndoorLevel objects are only equal by id. It is possible that may have different contents.

While a level is usually enclosed by a single building, a level might be enclosed by several buildings (e.g., a carpark level might span multiple buildings).

Public Method Summary

void
activate()
Sets this level as the visible level in its building.
boolean
equals(Object other)
Tests if this IndoorLevel is equal to another.
String
getName()
Localized display name for the level, e.g.
String
getShortName()
Localized short display name for the level, e.g.
int
hashCode()

Inherited Method Summary

Public Methods

public void activate ()

Sets this level as the visible level in its building. If a level is enclosed in several buildings, then all those buildings will have this level set as active.

public boolean equals (Object other)

Tests if this IndoorLevel is equal to another.

Parameters
other an Object.
Returns
  • true if both objects are the same object, that is, this == other.

public String getName ()

Localized display name for the level, e.g. "Ground floor". Returns an empty string if no name is defined.

public String getShortName ()

Localized short display name for the level, e.g. "1". Returns an empty string if no shortName is defined.

public int hashCode ()