TermImpl (KeY API Documentation)

java.lang.Object
- de.uka.ilkd.key.logic.TermImpl

All Implemented Interfaces:

SVSubstitute, Sorted, Term

Direct Known Subclasses:

LabeledTermImpl
```
class TermImpl
extends Object
implements Term
```
The currently only class implementing the Term interface. TermFactory should be the only class dealing directly with the TermImpl class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class TermImpl.ThreeValuedTruth

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TermImpl.ThreeValuedTruth`

Field Summary

Fields
Modifier and Type	Field and Description
`private ImmutableArray<QuantifiableVariable>`	`boundVars`
`private TermImpl.ThreeValuedTruth`	`containsJavaBlockRecursive` This flag indicates that the `Term` itself or one of its children contains a non empty `JavaBlock`.
`private int`	`depth`
`private static ImmutableArray<TermLabel>`	`EMPTY_LABEL_LIST`
`private static ImmutableArray<Term>`	`EMPTY_TERM_LIST`
`private static ImmutableArray<QuantifiableVariable>`	`EMPTY_VAR_LIST`
`private static NameAbstractionTable`	`FAILED` used to encode that `handleJava` results in an unsatisfiable constraint (faster than using exceptions)
`private ImmutableSet<QuantifiableVariable>`	`freeVars`
`private int`	`hashcode`
`private JavaBlock`	`javaBlock`
`private Operator`	`op`
`private TermImpl.ThreeValuedTruth`	`rigid`
`private int`	`serialNumber`
`private static AtomicInteger`	`serialNumberCounter`
`private ImmutableArray<Term>`	`subs`

Constructor Summary

Constructors
Constructor and Description

TermImpl(Operator op, ImmutableArray<Term> subs, ImmutableArray<QuantifiableVariable> boundVars, JavaBlock javaBlock)

Constructors
Constructor and Description
`TermImpl(Operator op, ImmutableArray<Term> subs, ImmutableArray<QuantifiableVariable> boundVars, JavaBlock javaBlock)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`arity()` The arity of the term.
`ImmutableArray<QuantifiableVariable>`	`boundVars()` The logical variables bound by the top level operator.
`Term`	`checked()` Checks whether the Term is valid on the top level.
`private static NameAbstractionTable`	`checkNat(NameAbstractionTable nat)`
`private static boolean`	`compareBoundVariables(QuantifiableVariable ownVar, QuantifiableVariable cmpVar, ImmutableList<QuantifiableVariable> ownBoundVars, ImmutableList<QuantifiableVariable> cmpBoundVars)` compare two quantifiable variables if they are equal modulo renaming
`protected int`	`computeHashCode()` performs teh actual computation of the hashcode and can be overwritten by subclasses if necessary
`boolean`	`containsLabel(TermLabel label)` checks if the given label is attached to the term
`int`	`depth()` The nesting depth of this term.
`private boolean`	`descendRecursively(Term t0, Term t1, ImmutableList<QuantifiableVariable> ownBoundVars, ImmutableList<QuantifiableVariable> cmpBoundVars, NameAbstractionTable nat)`
`private void`	`determineFreeVars()`
`boolean`	`equals(Object o)` true iff `o` is syntactically equal to this term
`boolean`	`equalsModRenaming(Term o)` Compares if two terms are equal modulo bound renaming
`void`	`execPostOrder(Visitor visitor)` The visitor is handed through till the bottom of the tree and then it walks upwards, while at each upstep the method visit of the visitor is called.
`void`	`execPreOrder(Visitor visitor)` The visitor walks downwards the tree, while at each downstep the method visit of the visitor is called.
`ImmutableSet<QuantifiableVariable>`	`freeVars()` The set of free quantifiable variables occurring in this term.
`TermLabel`	`getLabel(Name termLabelName)` Returns the first `TermLabel` with the given `Name`.
`ImmutableArray<TermLabel>`	`getLabels()` returns list of labels attached to this term
`private static NameAbstractionTable`	`handleJava(Term t0, Term t1, NameAbstractionTable nat)`
`private boolean`	`handleQuantifiableVariable(Term t0, Term t1, ImmutableList<QuantifiableVariable> ownBoundVars, ImmutableList<QuantifiableVariable> cmpBoundVars)`
`int`	`hashCode()`
`boolean`	`hasLabels()` returns true if the term is labeled
`private static int`	`indexOf(QuantifiableVariable var, ImmutableList<QuantifiableVariable> list)`
`boolean`	`isContainsJavaBlockRecursive()` Checks if the `Term` or one of its direct or indirect children contains a non empty `JavaBlock`.
`boolean`	`isRigid()` Whether all operators in this term are rigid.
`JavaBlock`	`javaBlock()` The Java block at top level.
`Operator`	`op()` The top operator (e.g., in "A and B" this is "and", in f(x,y) it is "f").
`<T> T`	`op(Class<T> opClass)` The top operator (e.g., in "A and B" this is "and", in f(x,y) it is "f") casted to the passed type.
`int`	`serialNumber()` Returns a serial number for a term.
`Sort`	`sort()` The sort of the term.
`Term`	`sub(int nr)` The `n`-th direct subterm.
`ImmutableArray<Term>`	`subs()` The subterms.
`String`	`toString()` returns a linearized textual representation of this term
`private boolean`	`unifyHelp(Term t0, Term t1, ImmutableList<QuantifiableVariable> ownBoundVars, ImmutableList<QuantifiableVariable> cmpBoundVars, NameAbstractionTable nat)` Compares two terms modulo bound renaming
`ImmutableArray<QuantifiableVariable>`	`varsBoundHere(int n)` The logical variables bound by the top level operator for the nth subterm.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_TERM_LIST
```
private static final ImmutableArray<Term> EMPTY_TERM_LIST
```
  - EMPTY_VAR_LIST
```
private static final ImmutableArray<QuantifiableVariable> EMPTY_VAR_LIST
```
  - EMPTY_LABEL_LIST
```
private static final ImmutableArray<TermLabel> EMPTY_LABEL_LIST
```
  - serialNumberCounter
```
private static AtomicInteger serialNumberCounter
```
  - serialNumber
```
private final int serialNumber
```
  - op
```
private final Operator op
```
  - subs
```
private final ImmutableArray<Term> subs
```
  - boundVars
```
private final ImmutableArray<QuantifiableVariable> boundVars
```
  - javaBlock
```
private final JavaBlock javaBlock
```
  - depth
```
private int depth
```
  - rigid
```
private TermImpl.ThreeValuedTruth rigid
```
  - freeVars
```
private ImmutableSet<QuantifiableVariable> freeVars
```
  - hashcode
```
private int hashcode
```
  - containsJavaBlockRecursive
```
private TermImpl.ThreeValuedTruth containsJavaBlockRecursive
```
    This flag indicates that the Term itself or one of its children contains a non empty JavaBlock. Terms which provides a JavaBlock directly or indirectly can't be cached because it is possible that the contained meta information inside the JavaBlock, e.g. PositionInfos, are different.
  - FAILED
```
private static NameAbstractionTable FAILED
```
    used to encode that handleJava results in an unsatisfiable constraint (faster than using exceptions)
- Constructor Detail
  - TermImpl
```
public TermImpl(Operator op,
                ImmutableArray<Term> subs,
                ImmutableArray<QuantifiableVariable> boundVars,
                JavaBlock javaBlock)
```
- Method Detail
  - determineFreeVars
```
private void determineFreeVars()
```
  - checked
```
public Term checked()
```
    Checks whether the Term is valid on the top level. If this is the case this method returns the Term unmodified. Otherwise a TermCreationException is thrown.
  - op
```
public Operator op()
```
    Description copied from interface: Term
    
    The top operator (e.g., in "A and B" this is "and", in f(x,y) it is "f").
    
    Specified by:
    
    op in interface Term
  - op
```
public <T> T op(Class<T> opClass)
         throws IllegalArgumentException
```
    Description copied from interface: Term
    
    The top operator (e.g., in "A and B" this is "and", in f(x,y) it is "f") casted to the passed type.
    
    Specified by:
    
    op in interface Term
    
    Throws:
    
    IllegalArgumentException
  - subs
```
public ImmutableArray<Term> subs()
```
    Description copied from interface: Term
    
    The subterms.
    
    Specified by:
    
    subs in interface Term
  - sub
```
public Term sub(int nr)
```
    Description copied from interface: Term
    
    The n-th direct subterm.
    
    Specified by:
    
    sub in interface Term
  - boundVars
```
public ImmutableArray<QuantifiableVariable> boundVars()
```
    Description copied from interface: Term
    
    The logical variables bound by the top level operator.
    
    Specified by:
    
    boundVars in interface Term
  - varsBoundHere
```
public ImmutableArray<QuantifiableVariable> varsBoundHere(int n)
```
    Description copied from interface: Term
    
    The logical variables bound by the top level operator for the nth subterm.
    
    Specified by:
    
    varsBoundHere in interface Term
  - javaBlock
```
public JavaBlock javaBlock()
```
    Description copied from interface: Term
    
    The Java block at top level.
    
    Specified by:
    
    javaBlock in interface Term
  - arity
```
public int arity()
```
    Description copied from interface: Term
    
    The arity of the term.
    
    Specified by:
    
    arity in interface Term
  - sort
```
public Sort sort()
```
    Description copied from interface: Term
    
    The sort of the term.
    
    Specified by:
    
    sort in interface Sorted
    
    Specified by:
    
    sort in interface Term
  - depth
```
public int depth()
```
    Description copied from interface: Term
    
    The nesting depth of this term.
    
    Specified by:
    
    depth in interface Term
  - isRigid
```
public boolean isRigid()
```
    Description copied from interface: Term
    
    Whether all operators in this term are rigid.
    
    Specified by:
    
    isRigid in interface Term
  - freeVars
```
public ImmutableSet<QuantifiableVariable> freeVars()
```
    Description copied from interface: Term
    
    The set of free quantifiable variables occurring in this term.
    
    Specified by:
    
    freeVars in interface Term
  - execPostOrder
```
public void execPostOrder(Visitor visitor)
```
    Description copied from interface: Term
    
    The visitor is handed through till the bottom of the tree and then it walks upwards, while at each upstep the method visit of the visitor is called.
    
    Specified by:
    
    execPostOrder in interface Term
    
    Parameters:
    
    visitor - the Visitor
  - execPreOrder
```
public void execPreOrder(Visitor visitor)
```
    Description copied from interface: Term
    
    The visitor walks downwards the tree, while at each downstep the method visit of the visitor is called.
    
    Specified by:
    
    execPreOrder in interface Term
    
    Parameters:
    
    visitor - the Visitor
  - equalsModRenaming
```
public final boolean equalsModRenaming(Term o)
```
    Description copied from interface: Term
    
    Compares if two terms are equal modulo bound renaming
    
    Specified by:
    
    equalsModRenaming in interface Term
    
    Returns:
    
    true iff the given Term has the same values in operator, sort, arity, varsBoundHere and javaBlock as this object modulo bound renaming
  - compareBoundVariables
```
private static boolean compareBoundVariables(QuantifiableVariable ownVar,
                                             QuantifiableVariable cmpVar,
                                             ImmutableList<QuantifiableVariable> ownBoundVars,
                                             ImmutableList<QuantifiableVariable> cmpBoundVars)
```
    compare two quantifiable variables if they are equal modulo renaming
    
    Parameters:
    
    ownVar - first QuantifiableVariable to be compared
    
    cmpVar - second QuantifiableVariable to be compared
    
    ownBoundVars - variables bound above the current position
    
    cmpBoundVars - variables bound above the current position
  - indexOf
```
private static int indexOf(QuantifiableVariable var,
                           ImmutableList<QuantifiableVariable> list)
```
    Returns:
    
    the index of the first occurrence of var in list, or -1 if the variable is not an element of the list
  - unifyHelp
```
private boolean unifyHelp(Term t0,
                          Term t1,
                          ImmutableList<QuantifiableVariable> ownBoundVars,
                          ImmutableList<QuantifiableVariable> cmpBoundVars,
                          NameAbstractionTable nat)
```
    Compares two terms modulo bound renaming
    
    Parameters:
    
    t0 - the first term
    
    t1 - the second term
    
    ownBoundVars - variables bound above the current position
    
    cmpBoundVars - variables bound above the current position
    
    Returns:
    
    true is returned iff the terms are equal modulo bound renaming
  - handleQuantifiableVariable
```
private boolean handleQuantifiableVariable(Term t0,
                                           Term t1,
                                           ImmutableList<QuantifiableVariable> ownBoundVars,
                                           ImmutableList<QuantifiableVariable> cmpBoundVars)
```
  - handleJava
```
private static NameAbstractionTable handleJava(Term t0,
                                               Term t1,
                                               NameAbstractionTable nat)
```
  - descendRecursively
```
private boolean descendRecursively(Term t0,
                                   Term t1,
                                   ImmutableList<QuantifiableVariable> ownBoundVars,
                                   ImmutableList<QuantifiableVariable> cmpBoundVars,
                                   NameAbstractionTable nat)
```
  - checkNat
```
private static NameAbstractionTable checkNat(NameAbstractionTable nat)
```
  - equals
```
public boolean equals(Object o)
```
    true iff o is syntactically equal to this term
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - computeHashCode
```
protected int computeHashCode()
```
    performs teh actual computation of the hashcode and can be overwritten by subclasses if necessary
  - toString
```
public String toString()
```
    returns a linearized textual representation of this term
    
    Overrides:
    
    toString in class Object
  - serialNumber
```
public int serialNumber()
```
    Description copied from interface: Term
    
    Returns a serial number for a term. The serial number is not persistent.
    
    Specified by:
    
    serialNumber in interface Term
  - hasLabels
```
public boolean hasLabels()
```
    Description copied from interface: Term
    
    returns true if the term is labeled
    
    Specified by:
    
    hasLabels in interface Term
  - containsLabel
```
public boolean containsLabel(TermLabel label)
```
    Description copied from interface: Term
    
    checks if the given label is attached to the term
    
    Specified by:
    
    containsLabel in interface Term
    
    Parameters:
    
    label - the TermLabel for which to look (must not be null)
  - getLabel
```
public TermLabel getLabel(Name termLabelName)
```
    Description copied from interface: Term
    
    Returns the first TermLabel with the given Name.
    
    Specified by:
    
    getLabel in interface Term
    
    Parameters:
    
    termLabelName - The Name of the TermLabel to search.
    
    Returns:
    
    The first found TermLabel or null if not available.
  - getLabels
```
public ImmutableArray<TermLabel> getLabels()
```
    Description copied from interface: Term
    
    returns list of labels attached to this term
    
    Specified by:
    
    getLabels in interface Term
    
    Returns:
    
    list of labels (maybe be empty but never null
  - isContainsJavaBlockRecursive
```
public boolean isContainsJavaBlockRecursive()
```
    Checks if the Term or one of its direct or indirect children contains a non empty JavaBlock.
    
    Specified by:
    
    isContainsJavaBlockRecursive in interface Term
    
    Returns:
    
    true The Term or one of its direct or indirect children contains a non empty JavaBlock, false no JavaBlock available.

Class TermImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_TERM_LIST

EMPTY_VAR_LIST

EMPTY_LABEL_LIST

serialNumberCounter

serialNumber

op

subs

boundVars

javaBlock

depth

rigid

freeVars

hashcode

containsJavaBlockRecursive

FAILED

Constructor Detail

TermImpl

Method Detail

determineFreeVars

checked

op

op

subs

sub

boundVars

varsBoundHere

javaBlock

arity

sort

depth

isRigid

freeVars

execPostOrder

execPreOrder

equalsModRenaming

compareBoundVariables

indexOf

unifyHelp

handleQuantifiableVariable

handleJava

descendRecursively

checkNat

equals

hashCode

computeHashCode

toString

serialNumber

hasLabels

containsLabel

getLabel

getLabels

isContainsJavaBlockRecursive