checkers.flow

Class DefaultFlowState

@NonNull java.lang.Object

checkers.flow.DefaultFlowState

All Implemented Interfaces:

FlowState

Direct Known Subclasses:

NullnessFlowState

public class DefaultFlowState
extends @NonNull Object
implements FlowState

Stores the annotation that is inferred for each variable.

Field Summary

Fields

Modifier and Type	Field and Description
GenKillBits<@Nullable AnnotationMirror>	annos Tracks the annotated state of each variable during flow.
protected Set<@Nullable AnnotationMirror>	annotations The annotations (qualifiers) to infer.
List<VariableElement>	vars Maps variables to a bit index.

Constructor Summary

Constructors

Constructor and Description
DefaultFlowState(Set<@Nullable AnnotationMirror> annotations) Create a new default flow state.

Method Summary

Methods

Modifier and Type	Method and Description
void	and(FlowState other, QualifierHierarchy annoRelations) "And" the current state with an other state, modifying only the current state.
DefaultFlowState	copy() Deeply copy the state of the current flow state.
DefaultFlowState	createFlowState(Set<@Nullable AnnotationMirror> annotations) Create a new instance of the current flow state class.
Set<@Nullable AnnotationMirror>	getAnnotations() The current set of annotations that can be inferred.
void	or(FlowState other, QualifierHierarchy annoRelations) "Or" the current state with an other state, modifying only the current state.
@ReadOnly String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

annotations

protected final Set<@Nullable AnnotationMirror> annotations

The annotations (qualifiers) to infer. The relationship among them is determined using the parameter to "and" and "or". By consulting the hierarchy, the analysis will only infer a qualifier on a type if it is more restrictive (i.e. a subtype) than the existing qualifier for that type.

vars

public List<VariableElement> vars

Maps variables to a bit index. This index is also used as the bit index to determine a variable's annotatedness using annos. In a previous implementation, vars was only copied when visitBlock or visitMethod was invoked. We now copy this field whenever we need to copy the state. TODO: look whether it's worth to optimize this.

See Also:

annos

annos

public GenKillBits<@Nullable AnnotationMirror> annos

Tracks the annotated state of each variable during flow. Bit indices correspond exactly to indices in vars.

Constructor Detail

DefaultFlowState

public DefaultFlowState(Set<@Nullable AnnotationMirror> annotations)

Create a new default flow state.

Parameters:

annotations - The annotations that can be inferred.

Method Detail

createFlowState

public DefaultFlowState createFlowState(Set<@Nullable AnnotationMirror> annotations)

Description copied from interface: FlowState

Create a new instance of the current flow state class. The type of the returned object has to be the same as the type of the receiver. This is used in FlowState.copy() to create a new instance of the correct type.

Specified by:

createFlowState in interface FlowState

Parameters:

annotations - The annotations that can be inferred.

Returns:

A new flow state instance.

getAnnotations

public Set<@Nullable AnnotationMirror> getAnnotations()

Description copied from interface: FlowState

The current set of annotations that can be inferred.

Specified by:

getAnnotations in interface FlowState

Returns:

A reference to the set of annotations.

copy

public DefaultFlowState copy()

Description copied from interface: FlowState

Deeply copy the state of the current flow state. The type of the returned object has to be the same as the type of the receiver.

Specified by:

copy in interface FlowState

Returns:

A completely independent copy of this.

or

public void or(FlowState other,
      QualifierHierarchy annoRelations)

Description copied from interface: FlowState

"Or" the current state with an other state, modifying only the current state.

Specified by:

or in interface FlowState

Parameters:

other - The other state, will not be modified.

annoRelations - The relationship between the qualifiers.

and

public void and(FlowState other,
       QualifierHierarchy annoRelations)

Description copied from interface: FlowState

"And" the current state with an other state, modifying only the current state.

Specified by:

and in interface FlowState

Parameters:

other - The other state, will not be modified.

annoRelations - The relationship between the qualifiers.

toString

public @ReadOnly String toString()

Overrides:

toString in class @NonNull Object