agi.foundation.coverage

(agi.foundation.spatial-2024r1.jar)

Enum CoverageFilterType

java.lang.Object

java.lang.Enum<CoverageFilterType>

agi.foundation.coverage.CoverageFilterType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CoverageFilterType>

public enum CoverageFilterType
extends Enum<CoverageFilterType>
implements Enumeration

Indicates whether an interval of coverage is valid based on the number of assets available.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_LEAST_N The number of accessible assets must be greater than or equal to the specified number.
AT_MOST_N The number of accessible assets must be less than or equal to the specified number.
EXACTLY_N The number of accessible assets must be exactly equal to the specified number.

Method Summary

Modifier and Type	Method and Description
static CoverageFilterType	getDefault() Get the enum constant that is considered to be the default.
static CoverageFilterType	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 CoverageFilterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CoverageFilterType[]	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

AT_LEAST_N

public static final CoverageFilterType AT_LEAST_N

The number of accessible assets must be greater than or equal to the specified number.

AT_MOST_N

public static final CoverageFilterType AT_MOST_N

The number of accessible assets must be less than or equal to the specified number.

EXACTLY_N

public static final CoverageFilterType EXACTLY_N

The number of accessible assets must be exactly equal to the specified number.

Method Detail

values

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

Returns:

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

valueOf

public static CoverageFilterType 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 CoverageFilterType 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 CoverageFilterType getDefault()

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

Returns:

The default enum constant.