Package org.checkerframework.framework.util.visualize

Class AbstractTypeInformationPresenter

java.lang.Object

org.checkerframework.framework.util.visualize.AbstractTypeInformationPresenter

All Implemented Interfaces:

TypeInformationPresenter

Direct Known Subclasses:

LspTypeInformationPresenter

public abstract class AbstractTypeInformationPresenter
extends Object
implements TypeInformationPresenter

Presents formatted type information for various AST trees in a class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractTypeInformationPresenter.TypeInformationReporter	A visitor which traverses a class tree and reports type information of various sub-trees.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedTypeFactory	atypeFactory	The AnnotatedTypeFactory for the current analysis.
protected final @Nullable GenericAnnotatedTypeFactory<? extends CFAbstractValue<?>,? extends CFAbstractStore<? extends CFAbstractValue<?>,?>,? extends CFAbstractTransfer<?,?,?>,? extends CFAbstractAnalysis<?,?,?>>	genFactory	The GenericAnnotatedTypeFactory for the current analysis.
protected final AnnotatedTypeFormatter	typeFormatter	This formats the ATMs that the presenter is going to present.

Constructor Summary

Constructors

Constructor	Description
AbstractTypeInformationPresenter(AnnotatedTypeFactory atypeFactory)	Constructs a presenter for the given factory.

Method Summary

Modifier and Type	Method	Description
protected AnnotatedTypeFormatter	createTypeFormatter()	Creates the AnnotatedTypeFormatter to use for output.
protected abstract AbstractTypeInformationPresenter.TypeInformationReporter	createTypeInformationReporter(ClassTree tree)	Creates the AbstractTypeInformationPresenter.TypeInformationReporter to use.
void	process(ClassTree tree, TreePath treePath)	The entry point for presenting type information of trees in the given class.

Methods inherited from class java.lang.Object

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

Field Details

atypeFactory

protected final AnnotatedTypeFactory atypeFactory

The AnnotatedTypeFactory for the current analysis.

genFactory

protected final @Nullable GenericAnnotatedTypeFactory<? extends CFAbstractValue<?>,? extends CFAbstractStore<? extends CFAbstractValue<?>,?>,? extends CFAbstractTransfer<?,?,?>,? extends CFAbstractAnalysis<?,?,?>> genFactory

The GenericAnnotatedTypeFactory for the current analysis. null if the factory is not an instance of GenericAnnotatedTypeFactory; otherwise, factory and genFactory refer to the same object.

typeFormatter

protected final AnnotatedTypeFormatter typeFormatter

This formats the ATMs that the presenter is going to present.

Constructor Details

AbstractTypeInformationPresenter

public AbstractTypeInformationPresenter(AnnotatedTypeFactory atypeFactory)

Constructs a presenter for the given factory.

Parameters:

atypeFactory - the AnnotatedTypeFactory for the current analysis

Method Details

process

public void process(ClassTree tree,
 TreePath treePath)

The entry point for presenting type information of trees in the given class.

Specified by:

process in interface TypeInformationPresenter

Parameters:

tree - a ClassTree that has been annotated by the factory

treePath - a TreePath to tree

createTypeInformationReporter

protected abstract AbstractTypeInformationPresenter.TypeInformationReporter createTypeInformationReporter(ClassTree tree)

Creates the AbstractTypeInformationPresenter.TypeInformationReporter to use.

Parameters:

tree - a ClassTree that has been annotated by the factory

Returns:

the AbstractTypeInformationPresenter.TypeInformationReporter to use

createTypeFormatter

protected AnnotatedTypeFormatter createTypeFormatter()

Creates the AnnotatedTypeFormatter to use for output.

Returns:

the AnnotatedTypeFormatter to use for output