org.sonar.javascript.se

Enum Constraint

java.lang.Object

java.lang.Enum<Constraint>

org.sonar.javascript.se.Constraint

All Implemented Interfaces:

Serializable, Comparable<Constraint>

public enum Constraint
extends Enum<Constraint>

This class represents a constraint which is met by a SymbolicValue in a given ProgramState. Possible constraints are NULL, UNDEFINED, TRUTHY, FALSY and any possible combination of them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_VALUE
FALSY
FALSY_NOT_NULL
FALSY_NOT_NULLY
FALSY_NOT_UNDEFINED
NO_POSSIBLE_VALUE
NOT_NULL
NOT_NULLY
NOT_UNDEFINED
NULL
NULL_OR_UNDEFINED
TRUTHY
TRUTHY_OR_NULL
TRUTHY_OR_NULLY
TRUTHY_OR_UNDEFINED
UNDEFINED

Method Summary

Modifier and Type	Method and Description
Constraint	and(Constraint other)
boolean	isIncompatibleWith(Constraint other)
boolean	isStricterOrEqualTo(Constraint other)
Constraint	not()
Nullability	nullability()
Truthiness	truthiness()
static Constraint	valueOf(String name) Returns the enum constant of this type with the specified name.
static Constraint[]	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

NO_POSSIBLE_VALUE

public static final Constraint NO_POSSIBLE_VALUE

NULL

public static final Constraint NULL

UNDEFINED

public static final Constraint UNDEFINED

NULL_OR_UNDEFINED

public static final Constraint NULL_OR_UNDEFINED

FALSY_NOT_NULLY

public static final Constraint FALSY_NOT_NULLY

FALSY_NOT_UNDEFINED

public static final Constraint FALSY_NOT_UNDEFINED

FALSY_NOT_NULL

public static final Constraint FALSY_NOT_NULL

FALSY

public static final Constraint FALSY

TRUTHY

public static final Constraint TRUTHY

TRUTHY_OR_NULL

public static final Constraint TRUTHY_OR_NULL

TRUTHY_OR_UNDEFINED

public static final Constraint TRUTHY_OR_UNDEFINED

TRUTHY_OR_NULLY

public static final Constraint TRUTHY_OR_NULLY

NOT_NULLY

public static final Constraint NOT_NULLY

NOT_UNDEFINED

public static final Constraint NOT_UNDEFINED

NOT_NULL

public static final Constraint NOT_NULL

ANY_VALUE

public static final Constraint ANY_VALUE

Method Detail

values

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

Returns:

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

valueOf

public static Constraint 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

and

public Constraint and(Constraint other)

not

public Constraint not()

truthiness

public Truthiness truthiness()

nullability

public Nullability nullability()

isStricterOrEqualTo

public boolean isStricterOrEqualTo(Constraint other)

isIncompatibleWith

public boolean isIncompatibleWith(Constraint other)