checkers.regex

Class RegexAnnotatedTypeFactory

@NonNull java.lang.Object

checkers.types.AnnotatedTypeFactory

checkers.types.BasicAnnotatedTypeFactory<RegexChecker>

checkers.regex.RegexAnnotatedTypeFactory

public class RegexAnnotatedTypeFactory
extends BasicAnnotatedTypeFactory<RegexChecker>

Adds Regex to the type of tree, in the following cases:

1. a String or char literal that is a valid regular expression
2. concatenation of two valid regular expression values (either String or char) or two partial regular expression values that make a valid regular expression when concatenated.
3. for calls to Pattern.compile changes the group count value of the return type to be the same as the parameter. For calls to the asRegex methods of the classes in asRegexClasses these asRegex methods will return a @Regex String with the same group count as the second argument to the call to asRegex.

Provides a basic analysis of concatenation of partial regular expressions to determine if a valid regular expression is produced by concatenating non-regular expression Strings. Do do this, PartialRegex is added to the type of tree in the following cases:

1. a String literal that is not a valid regular expression.
2. concatenation of two partial regex Strings that doesn't result in a regex String or a partial regex and regex String.

Also, adds PolyRegex to the type of String/char concatenation of a Regex and a PolyRegex or two PolyRegexs.

Nested Class Summary

Nested classes/interfaces inherited from class checkers.types.AnnotatedTypeFactory

AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields inherited from class checkers.types.BasicAnnotatedTypeFactory

checker, defaults, flow, FLOW_BY_DEFAULT, poly, treeAnnotator, typeAnnotator, useFlow

Fields inherited from class checkers.types.AnnotatedTypeFactory

annotations, atypes, elements, env, fromTreeCache, qualHierarchy, root, trees, types, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
RegexAnnotatedTypeFactory(RegexChecker checker, @Nullable CompilationUnitTree root)

Method Summary

Methods

Modifier and Type	Method and Description
Flow	createFlow(RegexChecker checker, @Nullable CompilationUnitTree tree, Set<@Nullable AnnotationMirror> flowQuals) Returns a Flow instance that performs flow sensitive analysis to infer qualifiers on unqualified types.
TreeAnnotator	createTreeAnnotator(RegexChecker checker) Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.

Methods inherited from class checkers.types.BasicAnnotatedTypeFactory

annotateImplicit, annotateImplicit, annotateImplicit, constructorFromUse, createFlowQualifiers, createTypeAnnotator, getDefaultedAnnotatedType, methodFromUse, postDirectSuperTypes, postInit

Methods inherited from class checkers.types.AnnotatedTypeFactory

addAliasedAnnotation, aliasedAnnotation, annotateInheritedFromClass, canHaveAnnotatedTypeParameters, createLRUCache, declarationFromElement, fromClass, fromElement, fromElement, fromElement, fromExpression, fromMember, fromNewClass, fromTypeTree, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFromTypeTree, getBoxedType, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getEnclosingType, getImplicitReceiverType, getPath, getQualifierHierarchy, getReceiverType, getSelfType, getUnboxedType, getVisitorState, isAnyEnclosingThisDeref, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, postAsMemberOf, toAnnotatedType, toString, typeVariablesFromUse, unify

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexAnnotatedTypeFactory

public RegexAnnotatedTypeFactory(RegexChecker checker,
                         @Nullable CompilationUnitTree root)

Method Detail

createFlow

public Flow createFlow(RegexChecker checker,
              @Nullable CompilationUnitTree tree,
              Set<@Nullable AnnotationMirror> flowQuals)

Description copied from class: BasicAnnotatedTypeFactory

Returns a Flow instance that performs flow sensitive analysis to infer qualifiers on unqualified types.

Overrides:

createFlow in class BasicAnnotatedTypeFactory<RegexChecker>

Parameters:

checker - the checker

tree - the compilation unit associated with this factory

flowQuals - the qualifiers to infer

Returns:

the flow analysis class

createTreeAnnotator

public TreeAnnotator createTreeAnnotator(RegexChecker checker)

Description copied from class: BasicAnnotatedTypeFactory

Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree. Subclasses may override this method to specify more appriopriate TreeAnnotator

Overrides:

createTreeAnnotator in class BasicAnnotatedTypeFactory<RegexChecker>

Returns:

a tree annotator