org.sonar.java.se.symbolicvalues

Class BinaryRelation

java.lang.Object

org.sonar.java.se.symbolicvalues.BinaryRelation

Direct Known Subclasses:

EqualRelation, GreaterThanOrEqualRelation, GreaterThanRelation, LessThanOrEqualRelation, LessThanRelation, MethodEqualsRelation, NotEqualRelation, NotMethodEqualsRelation

public abstract class BinaryRelation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BinaryRelation.TransitiveRelationExceededException

Field Summary

Fields

Modifier and Type	Field and Description
protected BinaryRelation	inverse
protected RelationalSymbolicValue.Kind	kind
protected SymbolicValue	leftOp
protected SymbolicValue	rightOp
protected BinaryRelation	symmetric

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BinaryRelation(RelationalSymbolicValue.Kind kind, SymbolicValue v1, SymbolicValue v2)

Method Summary

Methods

Modifier and Type	Method and Description
static BinaryRelation	binaryRelation(RelationalSymbolicValue.Kind kind, SymbolicValue leftOp, SymbolicValue rightOp)
protected abstract BinaryRelation	combinedAfter(BinaryRelation relation) Returns a new relation resulting of the transitive combination of the receiver with the supplied relation.
protected abstract BinaryRelation	combinedWithEqual(EqualRelation relation)
protected abstract BinaryRelation	combinedWithGreaterThan(GreaterThanRelation relation)
protected abstract BinaryRelation	combinedWithGreaterThanOrEqual(GreaterThanOrEqualRelation relation)
protected abstract BinaryRelation	combinedWithLessThan(LessThanRelation relation)
protected abstract BinaryRelation	combinedWithLessThanOrEqual(LessThanOrEqualRelation relation)
protected abstract BinaryRelation	combinedWithMethodEquals(MethodEqualsRelation relation)
protected abstract BinaryRelation	combinedWithNotEqual(NotEqualRelation relation)
protected abstract BinaryRelation	combinedWithNotMethodEquals(NotMethodEqualsRelation relation)
protected BinaryRelation	conjunction(BinaryRelation relation) Returns a new relation resulting of the conjunction of the receiver with the supplied relation.
boolean	equals(Object obj)
int	hashCode()
protected RelationState	implies(BinaryRelation relation)
protected abstract RelationState	impliesEqual()
protected abstract RelationState	impliesGreaterThan()
protected abstract RelationState	impliesGreaterThanOrEqual()
protected abstract RelationState	impliesLessThan()
protected abstract RelationState	impliesLessThanOrEqual()
protected abstract RelationState	impliesMethodEquals()
protected abstract RelationState	impliesNotEqual()
protected abstract RelationState	impliesNotMethodEquals()
BinaryRelation	inverse()
protected abstract RelationState	isImpliedBy(BinaryRelation relation)
protected RelationState	resolveState(Collection<BinaryRelation> knownRelations)
protected RelationState	resolveState(Collection<BinaryRelation> knownRelations, Set<BinaryRelation> usedRelations)
protected BinaryRelation	symmetric()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

kind

protected final RelationalSymbolicValue.Kind kind

leftOp

protected final SymbolicValue leftOp

rightOp

protected final SymbolicValue rightOp

symmetric

protected BinaryRelation symmetric

inverse

protected BinaryRelation inverse

Constructor Detail

BinaryRelation

protected BinaryRelation(RelationalSymbolicValue.Kind kind,
              SymbolicValue v1,
              SymbolicValue v2)

Method Detail

binaryRelation

public static BinaryRelation binaryRelation(RelationalSymbolicValue.Kind kind,
                            SymbolicValue leftOp,
                            SymbolicValue rightOp)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

resolveState

protected RelationState resolveState(Collection<BinaryRelation> knownRelations)

resolveState

@CheckForNull
protected RelationState resolveState(Collection<BinaryRelation> knownRelations,
                                      Set<BinaryRelation> usedRelations)

conjunction

@CheckForNull
protected BinaryRelation conjunction(BinaryRelation relation)

Returns a new relation resulting of the conjunction of the receiver with the supplied relation. Schema aRb & aSb => aTb where aRb is the relation described by the receiver, bSc that of the supplied relation, aTc is the returned relation.

Parameters:

relation - another relation bearing on the same operands as those of the receiver

Returns:

the resulting relation or null if the conjunction of both relations does not bring any new information

inverse

public BinaryRelation inverse()

Returns:

a new relation, the negation of the receiver

symmetric

protected BinaryRelation symmetric()

Returns:

a new relation, equivalent to the receiver with inverted parameters

implies

protected RelationState implies(BinaryRelation relation)

Parameters:

relation - a relation between symbolic values

Returns:

a RelationState

• FULFILLED if the receiver implies that the supplied relation is true
• UNFULFILLED if the receiver implies that the supplied relation is false
• UNDETERMINED otherwise

See Also:

RelationState

isImpliedBy

protected abstract RelationState isImpliedBy(BinaryRelation relation)

impliesEqual

protected abstract RelationState impliesEqual()

impliesNotEqual

protected abstract RelationState impliesNotEqual()

impliesMethodEquals

protected abstract RelationState impliesMethodEquals()

impliesNotMethodEquals

protected abstract RelationState impliesNotMethodEquals()

impliesGreaterThan

protected abstract RelationState impliesGreaterThan()

impliesGreaterThanOrEqual

protected abstract RelationState impliesGreaterThanOrEqual()

impliesLessThan

protected abstract RelationState impliesLessThan()

impliesLessThanOrEqual

protected abstract RelationState impliesLessThanOrEqual()

combinedAfter

@CheckForNull
protected abstract BinaryRelation combinedAfter(BinaryRelation relation)

Returns a new relation resulting of the transitive combination of the receiver with the supplied relation. Schema aRb & bSc => aTc where aRb is the relation described by the receiver, bSc that of the supplied relation, aTc is the returned relation.

Parameters:

relation - another relation whose left operand is the same as the receiver's right operand

Returns:

the resulting relation or null if the conjunction of both relations does not bring any new information

combinedWithEqual

@CheckForNull
protected abstract BinaryRelation combinedWithEqual(EqualRelation relation)

combinedWithNotEqual

@CheckForNull
protected abstract BinaryRelation combinedWithNotEqual(NotEqualRelation relation)

combinedWithMethodEquals

@CheckForNull
protected abstract BinaryRelation combinedWithMethodEquals(MethodEqualsRelation relation)

combinedWithNotMethodEquals

@CheckForNull
protected abstract BinaryRelation combinedWithNotMethodEquals(NotMethodEqualsRelation relation)

combinedWithGreaterThan

@CheckForNull
protected abstract BinaryRelation combinedWithGreaterThan(GreaterThanRelation relation)

combinedWithGreaterThanOrEqual

@CheckForNull
protected abstract BinaryRelation combinedWithGreaterThanOrEqual(GreaterThanOrEqualRelation relation)

combinedWithLessThan

@CheckForNull
protected abstract BinaryRelation combinedWithLessThan(LessThanRelation relation)

combinedWithLessThanOrEqual

@CheckForNull
protected abstract BinaryRelation combinedWithLessThanOrEqual(LessThanOrEqualRelation relation)