checkers.nullness
Class RawnessSubchecker

java.lang.Object
  javax.annotation.processing.AbstractProcessor
      com.sun.source.util.AbstractTypeProcessor
          checkers.source.SourceChecker
              checkers.basetype.BaseTypeChecker
                  checkers.nullness.RawnessSubchecker

All Implemented Interfaces:

Processor

@TypeQualifiers(value={Raw.class,NonRaw.class,PolyRaw.class})
public class RawnessSubchecker
extends BaseTypeChecker

A typechecker plug-in for the Nullness type system qualifier that finds (and verifies the absence of) null-pointer errors.

See Also:

NonNull, Nullable, Raw

See the Checker Framework manual:

Nullness Checker

Field Summary

Modifier and Type	Field and Description

Fields inherited from class checkers.source.SourceChecker

currentPath, currentRoot, env, messager, messages, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor and Description

RawnessSubchecker()

Method Summary

Modifier and Type	Method and Description
Collection<String>	getSuppressWarningsKey()
boolean	isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, AnnotatedTypeMirror.AnnotatedDeclaredType useType) Tests that the qualifiers present on the useType are valid qualifiers, given the qualifiers on the declaration of the type, declarationType.

Methods inherited from class checkers.basetype.BaseTypeChecker

createFactory, createQualifierHierarchy, createSourceVisitor, createSupportedTypeQualifiers, createTypeHierarchy, getQualifierHierarchy, getSupportedLintOptions, getSupportedTypeQualifiers, init, isAssignable, isSubtype

Methods inherited from class checkers.source.SourceChecker

getLintOption, getLintOption, getMessages, getProcessingEnvironment, getShouldSkip, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, message, report, typeProcess

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

process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

RawnessSubchecker

public RawnessSubchecker()

Method Detail

isValidUse

public boolean isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType,
                          AnnotatedTypeMirror.AnnotatedDeclaredType useType)

Description copied from class: BaseTypeChecker

Tests that the qualifiers present on the useType are valid qualifiers, given the qualifiers on the declaration of the type, declarationType.

The check is shallow, as it does not descend into generic or array types (i.e. only performing the validity check on the raw type or outmost array dimension). BaseTypeVisitor.validateTypeOf(Tree) would call this for each type argument or array dimention separately.

For instance, in the IGJ type system, a @Mutable is an invalid qualifier for String, as String is declared as @Immutable String.

In most cases, useType simply needs to be a subtype of declarationType, but there are exceptions. In IGJ, a variable may be declared @ReadOnly String, even though String is @Immutable String; ReadOnly is not a subtype of Immutable.

Overrides:

isValidUse in class BaseTypeChecker

Parameters:

declarationType - the type of the class (TypeElement)

useType - the use of the class (instance type)

Returns:

if the useType is a valid use of elemType

getSuppressWarningsKey

public Collection<String> getSuppressWarningsKey()

Overrides:

getSuppressWarningsKey in class SourceChecker

Returns:

String keys that a checker honors for suppressing warnings and errors that it issues

See Also:

SuppressWarningsKey