Module com.esri.arcgisruntime
Enum Class PreplannedPackagingStatus
java.lang.Object
java.lang.Enum<PreplannedPackagingStatus>
com.esri.arcgisruntime.tasks.offlinemap.PreplannedPackagingStatus
- All Implemented Interfaces:
Serializable
,Comparable<PreplannedPackagingStatus>
,Constable
Enumerates the different packaging states that an online
PreplannedMapArea
can be in.
A PreplannedMapArea
is made up of a set of data packages for each of the layers in the map.
When a web map author first creates a map area these packages must be prepared by the relevant
online services before the area is ready to be downloaded as an offline map.
PreplannedPackagingStatus
lists the possible packaging states for an online map area. The
area cannot be downloaded until the value is COMPLETE
.
- Since:
- 100.9.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIndicates that packaging is complete and thePreplannedMapArea
is ready to be downloaded.Indicates that a failure occurred when creating the packages for thePreplannedMapArea
.Indicates that thePreplannedMapArea
is not yet ready for download.Indicates that the packaging status of thePreplannedMapArea
is unknown. -
Method Summary
Modifier and TypeMethodDescriptionstatic PreplannedPackagingStatus
Returns the enum constant of this class with the specified name.static PreplannedPackagingStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
Indicates that the packaging status of thePreplannedMapArea
is unknown. This status is returned when your app does not yet know the status of the online area. For example, this would be the case when thePreplannedMapArea
has a load status ofLoadStatus.NOT_LOADED
.- Since:
- 100.9.0
-
PROCESSING
Indicates that thePreplannedMapArea
is not yet ready for download. This is the initial status for aPreplannedMapArea
that has been created on the web map, but is not yet ready for download.- Since:
- 100.9.0
-
FAILED
Indicates that a failure occurred when creating the packages for thePreplannedMapArea
. This status means that thePreplannedMapArea
cannot be downloaded. Failures encountered while creating packages need to be addressed by the web map author.- Since:
- 100.9.0
-
COMPLETE
Indicates that packaging is complete and thePreplannedMapArea
is ready to be downloaded. This status means that all packages required to download thePreplannedMapArea
have been successfully prepared.- Since:
- 100.9.0
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-