org.checkerframework.checker.experimental.regex_qual

Class RegexQualifiedTypeFactory

java.lang.Object

org.checkerframework.qualframework.base.DefaultQualifiedTypeFactory<Regex>

org.checkerframework.checker.experimental.regex_qual.RegexQualifiedTypeFactory

All Implemented Interfaces:

QualifiedTypeFactory<Regex>

public class RegexQualifiedTypeFactory
extends DefaultQualifiedTypeFactory<Regex>

The QualifiedTypeFactory for the Regex-Qual type system. Note: Polymorphic qualifiers are not supported automatically by the qual system. Instead, only the most basic and required polymorphic methods are manually supported by visitMethodInvocation. see org.checkerframework.checker.regex.RegexAnnotatedTypeFactory

Constructor Summary

Constructors

Constructor and Description
RegexQualifiedTypeFactory(QualifierContext<Regex> checker)

Method Summary

Modifier and Type	Method and Description
protected AnnotationConverter<Regex>	createAnnotationConverter() Constructs an AnnotationConverter for the current type system.
QualAnalysis<Regex>	createFlowAnalysis(List<Pair<VariableElement,QualValue<Regex>>> fieldValues) Configure dataflow to use the RegexQualifiedTransfer.
protected QualifierHierarchy<Regex>	createQualifierHierarchy() Constructs a QualifierHierarchy for the current type system.
protected TreeAnnotator<Regex>	createTreeAnnotator() Constructs the TreeAnnotator to be used by this type factory.
Regex	getEffectiveQualifier(QualifiedTypeMirror<Regex> mirror)
static int	getGroupCount(String regex) Returns the number of groups in the given regex String.

Methods inherited from class org.checkerframework.qualframework.base.DefaultQualifiedTypeFactory

computeQualifiedTypeParameterBounds, constructorFromUse, createQualifiedTypes, createTypeAnnotator, createTypeHierarchy, createTypeVariableSubstitutor, getAnnotationConverter, getContext, getDeclAnnotations, getDecoratedElement, getPath, getQualifiedType, getQualifiedType, getQualifiedTypeFromTypeTree, getQualifiedTypeParameterBounds, getQualifiedTypes, getQualifierHierarchy, getReceiverType, getTypeHierarchy, methodFromUse, methodFromUse, postAsMemberOf, postDirectSuperTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexQualifiedTypeFactory

public RegexQualifiedTypeFactory(QualifierContext<Regex> checker)

Method Detail

createQualifierHierarchy

protected QualifierHierarchy<Regex> createQualifierHierarchy()

Description copied from class: DefaultQualifiedTypeFactory

Constructs a QualifierHierarchy for the current type system. Every checker must override this method to return an appropriate QualifierHierarchy subclass for that checker.

Specified by:

createQualifierHierarchy in class DefaultQualifiedTypeFactory<Regex>

createAnnotationConverter

protected AnnotationConverter<Regex> createAnnotationConverter()

Description copied from class: DefaultQualifiedTypeFactory

Constructs an AnnotationConverter for the current type system. Every checker must override this method to return an appropriate AnnotationConverter subclass for that checker.

Specified by:

createAnnotationConverter in class DefaultQualifiedTypeFactory<Regex>

createTreeAnnotator

protected TreeAnnotator<Regex> createTreeAnnotator()

Description copied from class: DefaultQualifiedTypeFactory

Constructs the TreeAnnotator to be used by this type factory. Checkers that need custom TreeAnnotator behavior should override this method to return an instance of their custom TreeAnnotator subclass.

Overrides:

createTreeAnnotator in class DefaultQualifiedTypeFactory<Regex>

getGroupCount

public static int getGroupCount(String regex)

Returns the number of groups in the given regex String.

createFlowAnalysis

public QualAnalysis<Regex> createFlowAnalysis(List<Pair<VariableElement,QualValue<Regex>>> fieldValues)

Configure dataflow to use the RegexQualifiedTransfer.

Specified by:

createFlowAnalysis in interface QualifiedTypeFactory<Regex>

Overrides:

createFlowAnalysis in class DefaultQualifiedTypeFactory<Regex>

Parameters:

fieldValues - the initial field values

Returns:

the QualAnalysis to use

getEffectiveQualifier

public Regex getEffectiveQualifier(QualifiedTypeMirror<Regex> mirror)