htsjdk.variant.variantcontext

Enum JexlMissingValueTreatment

java.lang.Object

java.lang.Enum<JexlMissingValueTreatment>

htsjdk.variant.variantcontext.JexlMissingValueTreatment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JexlMissingValueTreatment>

public enum JexlMissingValueTreatment
extends java.lang.Enum<JexlMissingValueTreatment>

How to treat values that appear in a jexl expression but are missing in the context it's applied to

Enum Constant Summary

Enum Constants

Enum Constant and Description
THROW Treat expressions with a missing value as an error and throw an IllegalArgumentException
TREAT_AS_MATCH Treat expressions with a missing value as a match and evaluate to true
TREAT_AS_MISMATCH Treat expressions with a missing value as a mismatch and evaluate to false

Method Summary

Modifier and Type	Method and Description
static JexlMissingValueTreatment	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JexlMissingValueTreatment[]	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

TREAT_AS_MISMATCH

public static final JexlMissingValueTreatment TREAT_AS_MISMATCH

Treat expressions with a missing value as a mismatch and evaluate to false

TREAT_AS_MATCH

public static final JexlMissingValueTreatment TREAT_AS_MATCH

Treat expressions with a missing value as a match and evaluate to true

THROW

public static final JexlMissingValueTreatment THROW

Treat expressions with a missing value as an error and throw an IllegalArgumentException

Method Detail

values

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

Returns:

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

valueOf

public static JexlMissingValueTreatment 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 name

java.lang.NullPointerException - if the argument is null