org.checkerframework.checker.guieffect

Class GuiEffectVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<java.lang.Void,java.lang.Void>

org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

org.checkerframework.checker.guieffect.GuiEffectVisitor

All Implemented Interfaces:

TreeVisitor<java.lang.Void,java.lang.Void>

public class GuiEffectVisitor
extends org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

Require that only UI code invokes code with the UI effect.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GuiEffectVisitor.GuiEffectOverrideChecker

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

org.checkerframework.common.basetype.BaseTypeVisitor.OverrideChecker

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayDeque<MethodTree>	currentMethods
protected boolean	debugSpew
protected java.util.ArrayDeque<Effect>	effStack

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

atypeFactory, checker, contractsUtils, positions, typeValidator, visitorState

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
GuiEffectVisitor(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
protected void	checkMethodInvocability(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType method, MethodInvocationTree node)
protected org.checkerframework.common.basetype.BaseTypeVisitor.OverrideChecker	createOverrideChecker(Tree overriderTree, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType overrider, org.checkerframework.framework.type.AnnotatedTypeMirror overridingType, org.checkerframework.framework.type.AnnotatedTypeMirror overridingReturnType, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType overridden, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, org.checkerframework.framework.type.AnnotatedTypeMirror overriddenReturnType)
protected GuiEffectTypeFactory	createTypeFactory()
protected java.util.Set<? extends javax.lang.model.element.AnnotationMirror>	getExceptionParameterLowerBoundAnnotations()
boolean	isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType useType, Tree tree)
java.lang.Void	visitAssignment(AssignmentTree node, java.lang.Void p)
java.lang.Void	visitMethod(MethodTree node, java.lang.Void p)
java.lang.Void	visitMethodInvocation(MethodInvocationTree node, java.lang.Void p)
java.lang.Void	visitReturn(ReturnTree node, java.lang.Void p)
java.lang.Void	visitVariable(VariableTree node, java.lang.Void p)

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkArguments, checkArrayInitialization, checkAssignability, checkConditionalPostcondition, checkConstructorInvocation, checkContract, checkDefaultConstructor, checkExceptionParameter, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, createTypeValidator, enclosingMemberSelect, enclosingStatement, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isAssignable, isValidUse, isValidUse, isVectorCopyInto, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitNewArray, visitNewClass, visitParameterizedType, visitThrow, visitTypeCast, visitTypeParameter, visitUnary

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitArrayType, visitAssert, visitBinary, visitBlock, visitBreak, visitCase, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitOther, visitParenthesized, visitPrimitiveType, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Field Detail

debugSpew

protected final boolean debugSpew

effStack

protected final java.util.ArrayDeque<Effect> effStack

currentMethods

protected final java.util.ArrayDeque<MethodTree> currentMethods

Constructor Detail

GuiEffectVisitor

public GuiEffectVisitor(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Detail

createTypeFactory

protected GuiEffectTypeFactory createTypeFactory()

Overrides:

createTypeFactory in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

checkMethodInvocability

protected void checkMethodInvocability(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType method,
                                       MethodInvocationTree node)

Overrides:

checkMethodInvocability in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

createOverrideChecker

protected org.checkerframework.common.basetype.BaseTypeVisitor.OverrideChecker createOverrideChecker(Tree overriderTree,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType overrider,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror overridingType,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror overridingReturnType,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType overridden,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType,
                                                                                                     org.checkerframework.framework.type.AnnotatedTypeMirror overriddenReturnType)

Overrides:

createOverrideChecker in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

getExceptionParameterLowerBoundAnnotations

protected java.util.Set<? extends javax.lang.model.element.AnnotationMirror> getExceptionParameterLowerBoundAnnotations()

Overrides:

getExceptionParameterLowerBoundAnnotations in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

isValidUse

public boolean isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType declarationType,
                          org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType useType,
                          Tree tree)

Overrides:

isValidUse in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

visitVariable

public java.lang.Void visitVariable(VariableTree node,
                                    java.lang.Void p)

Specified by:

visitVariable in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitVariable in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

visitAssignment

public java.lang.Void visitAssignment(AssignmentTree node,
                                      java.lang.Void p)

Specified by:

visitAssignment in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitAssignment in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

visitReturn

public java.lang.Void visitReturn(ReturnTree node,
                                  java.lang.Void p)

Specified by:

visitReturn in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitReturn in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

visitMethodInvocation

public java.lang.Void visitMethodInvocation(MethodInvocationTree node,
                                            java.lang.Void p)

Specified by:

visitMethodInvocation in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethodInvocation in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>

visitMethod

public java.lang.Void visitMethod(MethodTree node,
                                  java.lang.Void p)

Specified by:

visitMethod in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethod in class org.checkerframework.common.basetype.BaseTypeVisitor<GuiEffectTypeFactory>