Package com.here.sdk.maploader

Enum Class PersistentMapStatus

java.lang.Object
java.lang.Enum<PersistentMapStatus>
com.here.sdk.maploader.PersistentMapStatus
All Implemented Interfaces:
Serializable, Comparable<PersistentMapStatus>, Constable
public enum PersistentMapStatus extends Enum<PersistentMapStatus>

Specifies possible statuses of the already downloaded map regions as a whole. Note: This can be valid only for a single region in case of a CORRUPTED state.

  • Enum Constant Details

    • OK

      public static final PersistentMapStatus OK

      All downloaded regions are in a workable state, no issues found.

    • CORRUPTED

      public static final PersistentMapStatus CORRUPTED

      One or more downloaded regions failed to open and a repair action should be performed to mitigate this issue. All map download and map update operations (except for sdk.maploader.MapDownloader.repair_persistent_map) will return sdk.maploader.MapLoaderError.NOT_READY.

    • BROKEN_UPDATE

      public static final PersistentMapStatus BROKEN_UPDATE

      Unrecoverable error during construction of pending update parameters. Operations such as catalog updates or region downloads will fail. The healing procedure is to clean persistent map with sdk.maploader.MapDownloader.clear_persistent_map_storage.

    • MIGRATION_NEEDED

      public static final PersistentMapStatus MIGRATION_NEEDED

      Indicates that the downloaded regions need to be migrated to a new internal format by calling sdk.maploader.MapDownloader.repair_persistent_map. This error is not a result of a data loss, nor any data will be lost when performing the repair operation and the map version will stay unchanged afterwards.

    • PENDING_UPDATE

      public static final PersistentMapStatus PENDING_UPDATE

      A map update operation initiated by a user has been interrupted. Calls to sdk.maploader.MapDownloader.download_regions and sdk.maploader.MapDownloader.delete_regions will fail with sdk.maploader.MapLoaderError.INTERNAL_ERROR. To repair a map, call again sdk.maploader.MapUpdater.update_catalog for the affected catalog. sdk.maploader.MapUpdater.retrieve_catalogs_update_info returns a list of sdk.maploader.CatalogUpdateInfo items: The affected catalog can be identified by the state, which is set to sdk.maploader.CatalogUpdateState.PENDING_UPDATE. To know if a map needs to be repaired, check if sdk.maploader.MapLoaderError.PENDING_UPDATE has occurred.

    • INVALID_PATH

      public static final PersistentMapStatus INVALID_PATH

      Unreachable SDKOptions.cachePath or SDKOptions.persistentMapStoragePath. Make sure that SDKOptions has accessible SDKOptions.cachePath and SDKOptions.persistentMapStoragePath

    • INVALID_STATE

      public static final PersistentMapStatus INVALID_STATE

      Unrecoverable error during construction of internal map access object. The healing procedure is to clean persistent map with sdk.maploader.MapDownloader.clear_persistent_map_storage.

    • STORAGE_CLOSED

      public static final PersistentMapStatus STORAGE_CLOSED

      Indicates that the status cannot be retrieved as the map storage is already closed due to disposal of SDKNativeEngine.

  • Method Details

    • values

      public static PersistentMapStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PersistentMapStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null