Package com.esri.arcgisruntime.ogc.kml
Enum KmlRefreshMode
- java.lang.Object
-
- java.lang.Enum<KmlRefreshMode>
-
- com.esri.arcgisruntime.ogc.kml.KmlRefreshMode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<KmlRefreshMode>
public enum KmlRefreshMode extends java.lang.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)
-
-
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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static KmlRefreshMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static KmlRefreshMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static KmlRefreshMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (KmlRefreshMode c : KmlRefreshMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static KmlRefreshMode valueOf(java.lang.String name)
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.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-