Package org.sonar.java.se.constraint

Enum ObjectConstraint

java.lang.Object

java.lang.Enum<ObjectConstraint>

org.sonar.java.se.constraint.ObjectConstraint

All Implemented Interfaces:

Serializable, Comparable<ObjectConstraint>, Constraint

public enum ObjectConstraint
extends Enum<ObjectConstraint>
implements Constraint

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_NULL
NULL

Method Summary

Modifier and Type	Method	Description
Constraint	copyOver(RelationalSymbolicValue.Kind kind)	Return constraint which should be applied to the rhs of the relation, if this constraint is set on the lhs of the relation.
boolean	hasPreciseValue()
Constraint	inverse()
boolean	isNull()
boolean	isValidWith(Constraint constraint)
String	valueAsString()
static ObjectConstraint	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ObjectConstraint[]	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

NULL

public static final ObjectConstraint NULL

NOT_NULL

public static final ObjectConstraint NOT_NULL

Method Detail

values

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

Returns:

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

valueOf

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

isNull

public boolean isNull()

hasPreciseValue

public boolean hasPreciseValue()

Specified by:

hasPreciseValue in interface Constraint

Returns:

true if value represented by this SV is precisely known.

valueAsString

public String valueAsString()

Specified by:

valueAsString in interface Constraint

Returns:

String representation of value encoded by constraint for purpose of flow message

isValidWith

public boolean isValidWith(@Nullable
                           Constraint constraint)

Specified by:

isValidWith in interface Constraint

copyOver

@Nullable
public Constraint copyOver(RelationalSymbolicValue.Kind kind)

Description copied from interface: Constraint

Return constraint which should be applied to the rhs of the relation, if this constraint is set on the lhs of the relation.

Specified by:

copyOver in interface Constraint

Parameters:

kind - kind of relation over which constraint is copied

Returns:

constraint to be set on rhs, null if no constraint should be set

inverse

public Constraint inverse()

Specified by:

inverse in interface Constraint