checkers.flow

Interface FlowState

All Known Implementing Classes:

DefaultFlowState, NullnessFlowState

public interface FlowState

The state that is managed by a flow inference implementation.

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.
FlowState	copy() Deeply copy the state of the current flow state.
FlowState	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.

Method Detail

createFlowState

FlowState createFlowState(Set<@Nullable AnnotationMirror> annotations)

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 copy() to create a new instance of the correct type.

Parameters:

annotations - The annotations that can be inferred.

Returns:

A new flow state instance.

getAnnotations

Set<@Nullable AnnotationMirror> getAnnotations()

The current set of annotations that can be inferred.

Returns:

A reference to the set of annotations.

copy

FlowState copy()

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.

Returns:

A completely independent copy of this.

or

void or(FlowState other,
      QualifierHierarchy annoRelations)

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

Parameters:

other - The other state, will not be modified.

annoRelations - The relationship between the qualifiers.

and

void and(FlowState other,
       QualifierHierarchy annoRelations)

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

Parameters:

other - The other state, will not be modified.

annoRelations - The relationship between the qualifiers.