Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.ogc.kml

Enum Class KmlRefreshMode

java.lang.Object

java.lang.Enum<KmlRefreshMode>

com.esri.arcgisruntime.ogc.kml.KmlRefreshMode

All Implemented Interfaces:

Serializable, Comparable<KmlRefreshMode>, Constable

public enum KmlRefreshMode
extends Enum<KmlRefreshMode>

KML refresh modes.

Defines the time-based refresh behavior of a KML network link or an image overlay.

Since:

100.6.0

See Also:

• KmlIcon.setRefreshMode(KmlRefreshMode)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ON_CHANGE	Refresh when the resource is loaded and whenever the Link parameters change.
ON_EXPIRE	Refresh the resource when the expiration time is reached.
ON_INTERVAL	Refresh every n milliseconds, where n is specified by refreshInterval.

Method Summary

Modifier and Type	Method	Description
static KmlRefreshMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KmlRefreshMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ON_CHANGE

public static final KmlRefreshMode ON_CHANGE

Refresh when the resource is loaded and whenever the Link parameters change.

Since:

100.6.0

ON_INTERVAL

public static final KmlRefreshMode ON_INTERVAL

Refresh every n milliseconds, where n is specified by refreshInterval.

If refreshInterval is not set when the mode is set to ON_INTERVAL, it will automatically update the refreshInterval to 4000 milliseconds.

Since:

100.6.0

ON_EXPIRE

public static final KmlRefreshMode ON_EXPIRE

Refresh the resource when the expiration time is reached.

Since:

100.6.0

Method Details

values

public static KmlRefreshMode[] 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 KmlRefreshMode 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