Package uk.ac.starlink.ttools.cone
Enum Coverage.Amount
- java.lang.Object
-
- java.lang.Enum<Coverage.Amount>
-
- uk.ac.starlink.ttools.cone.Coverage.Amount
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Coverage.Amount>
- Enclosing interface:
- Coverage
public static enum Coverage.Amount extends java.lang.Enum<Coverage.Amount>
Describes a type of coverage.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Boolean
getKnownResult()
Returns the single fixed answer to all coverage queries.static Coverage.Amount
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Coverage.Amount[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NO_DATA
public static final Coverage.Amount NO_DATA
No coverage data is known.
-
NO_SKY
public static final Coverage.Amount NO_SKY
Coverage data is known; no sky regions are covered.
-
ALL_SKY
public static final Coverage.Amount ALL_SKY
Coverage data is known; the whole sky is covered.
-
SOME_SKY
public static final Coverage.Amount SOME_SKY
Coverage data is known; some, but not all of the sky is covered.
-
-
Method Detail
-
values
public static Coverage.Amount[] 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 (Coverage.Amount c : Coverage.Amount.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Coverage.Amount 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
-
getKnownResult
public java.lang.Boolean getKnownResult()
Returns the single fixed answer to all coverage queries. For an interesting coverage, the result is null (no fixed answer), but for other types a fixed value of True or False may be returned.- Returns:
- constant answer to footprint queries
-
-