agi.foundation.graphics

(agi.foundation.graphics-2024r3.jar)

Enum KmlNetworkLinkRefreshMode

java.lang.Object

java.lang.Enum<KmlNetworkLinkRefreshMode>

agi.foundation.graphics.KmlNetworkLinkRefreshMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KmlNetworkLinkRefreshMode>

public enum KmlNetworkLinkRefreshMode
extends Enum<KmlNetworkLinkRefreshMode>
implements Enumeration

Defines the options available for a KmlNetworkLink's RefreshMode property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ON_CHANGE Refresh when the document is loaded and whenever the Link parameters change (the default).
ON_EXPIRE Refresh the network link when the expiration time is reached.
ON_INTERVAL Refresh the network link at the duration specified by RefreshInterval (get).

Method Summary

Modifier and Type	Method and Description
static KmlNetworkLinkRefreshMode	getDefault() Get the enum constant that is considered to be the default.
static KmlNetworkLinkRefreshMode	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static KmlNetworkLinkRefreshMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static KmlNetworkLinkRefreshMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ON_CHANGE

public static final KmlNetworkLinkRefreshMode ON_CHANGE

Refresh when the document is loaded and whenever the Link parameters change (the default).

ON_INTERVAL

public static final KmlNetworkLinkRefreshMode ON_INTERVAL

Refresh the network link at the duration specified by RefreshInterval (get).

ON_EXPIRE

public static final KmlNetworkLinkRefreshMode ON_EXPIRE

Refresh the network link when the expiration time is reached.

Method Detail

values

public static KmlNetworkLinkRefreshMode[] 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 (KmlNetworkLinkRefreshMode c : KmlNetworkLinkRefreshMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KmlNetworkLinkRefreshMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static KmlNetworkLinkRefreshMode getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static KmlNetworkLinkRefreshMode getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.