org.checkerframework.checker.optional

Class OptionalVisitor

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<BaseAnnotatedTypeFactory>

org.checkerframework.checker.optional.OptionalVisitor

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

public class OptionalVisitor
extends BaseTypeVisitor<BaseAnnotatedTypeFactory>

The OptionalVisitor enforces the Optional Checker rules. These rules are described in the Checker Framework Manual.

See the Checker Framework Manual:

Optional Checker

Nested Class Summary

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

BaseTypeVisitor.OverrideChecker

Field Summary

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

atypeFactory, checker, contractsUtils, positions, TARGET, targetValueElement, typeValidator, visitorState

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

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
OptionalVisitor(BaseTypeChecker checker) Create an OptionalVisitor.

Method Summary

Modifier and Type	Method and Description
protected BaseTypeValidator	createTypeValidator()
void	handleConditionalStatementIsPresentGet(com.sun.source.tree.IfTree node) Part of rule #3.
void	handleCreationElimination(com.sun.source.tree.MethodInvocationTree node) Rule #4.
void	handleTernaryIsPresentGet(com.sun.source.tree.ConditionalExpressionTree node) Part of rule #3.
static com.sun.source.tree.StatementTree	skipBlocks(com.sun.source.tree.StatementTree tree) If the given tree is a block tree with a single element, return the enclosed non-block statement.
java.lang.Void	visitConditionalExpression(com.sun.source.tree.ConditionalExpressionTree node, java.lang.Void p) If the computation of the type of the ConditionalExpressionTree in org.checkerframework.framework.type.TypeFromTree.TypeFromExpression.visitConditionalExpression(ConditionalExpressionTree, AnnotatedTypeFactory) is correct, the following checks are redundant.
java.lang.Void	visitIf(com.sun.source.tree.IfTree node, java.lang.Void p)
java.lang.Void	visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node, java.lang.Void p) Performs a method invocation check.
java.lang.Void	visitVariable(com.sun.source.tree.VariableTree node, java.lang.Void p) Rule #6 (partial).

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

checkAccess, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExtendsImplements, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, createOverrideChecker, createTypeFactory, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isTypeCastSafe, isValidUse, isValidUse, isValidUse, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitNewArray, visitNewClass, visitReturn, 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, visitExports, visitExpressionStatement, visitForLoop, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitUses, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalVisitor

public OptionalVisitor(BaseTypeChecker checker)

Create an OptionalVisitor.

Method Detail

createTypeValidator

protected BaseTypeValidator createTypeValidator()

Overrides:

createTypeValidator in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitConditionalExpression

public java.lang.Void visitConditionalExpression(com.sun.source.tree.ConditionalExpressionTree node,
                                                 java.lang.Void p)

Description copied from class: BaseTypeVisitor

If the computation of the type of the ConditionalExpressionTree in org.checkerframework.framework.type.TypeFromTree.TypeFromExpression.visitConditionalExpression(ConditionalExpressionTree, AnnotatedTypeFactory) is correct, the following checks are redundant. However, let's add another failsafe guard and do the checks.

Specified by:

visitConditionalExpression in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitConditionalExpression in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

handleTernaryIsPresentGet

public void handleTernaryIsPresentGet(com.sun.source.tree.ConditionalExpressionTree node)

Part of rule #3.

Pattern match for: VAR.isPresent() ? VAR.get().METHOD() : VALUE

Prefer: VAR.map(METHOD).orElse(VALUE);

visitIf

public java.lang.Void visitIf(com.sun.source.tree.IfTree node,
                              java.lang.Void p)

Specified by:

visitIf in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitIf in class com.sun.source.util.TreeScanner<java.lang.Void,java.lang.Void>

handleConditionalStatementIsPresentGet

public void handleConditionalStatementIsPresentGet(com.sun.source.tree.IfTree node)

Part of rule #3.

Pattern match for: if (VAR.isPresent()) { METHOD(VAR.get()); }

Prefer: VAR.ifPresent(METHOD);

visitMethodInvocation

public java.lang.Void visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node,
                                            java.lang.Void p)

Description copied from class: BaseTypeVisitor

Performs a method invocation check.

An invocation of a method, m, on the receiver, r is valid only if:

• passed arguments are subtypes of corresponding m parameters
• r is a subtype of m receiver type
• if m is generic, passed type arguments are subtypes of m type variables

Specified by:

visitMethodInvocation in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

handleCreationElimination

public void handleCreationElimination(com.sun.source.tree.MethodInvocationTree node)

Rule #4.

Pattern match for: CREATION().ELIMINATION()

Prefer: VAR.ifPresent(METHOD);

visitVariable

public java.lang.Void visitVariable(com.sun.source.tree.VariableTree node,
                                    java.lang.Void p)

Rule #6 (partial).

Don't use Optional in fields and method parameters.

Specified by:

visitVariable in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitVariable in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

skipBlocks

public static com.sun.source.tree.StatementTree skipBlocks(com.sun.source.tree.StatementTree tree)

If the given tree is a block tree with a single element, return the enclosed non-block statement. Otherwise, return the same tree.

Parameters:

tree - a statement tree

Returns:

the single enclosed statement, if it exists; otherwise, the same tree