checkers.units

Class UnitsChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.SourceChecker

checkers.basetype.BaseTypeChecker

checkers.units.UnitsChecker

All Implemented Interfaces:

Processor

public class UnitsChecker
extends BaseTypeChecker

Units Checker main class. Supports "units" option to add support for additional units.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UnitsChecker.UnitsQualifierHierarchy

Nested classes/interfaces inherited from class checkers.source.SourceChecker

SourceChecker.CheckerError

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<@ReadOnly String,UnitsRelations>	unitsRel
protected AnnotationUtils	utils

Fields inherited from class checkers.source.SourceChecker

currentPath, currentRoot, messager, messages, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
UnitsChecker()

Method Summary

Methods

Modifier and Type	Method and Description
QualifierHierarchy	createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory) Factory method to easily change what QualifierHierarchy is created.
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers() Copied from BasicChecker and adapted "quals" to "units".
Collection<@ReadOnly String>	getSuppressWarningsKey() Copied from BasicChecker; cannot reuse it, because BasicChecker is final.
void	initChecker() Initialize the checker.

Methods inherited from class checkers.basetype.BaseTypeChecker

createFactory, createQualifierHierarchy, createQualifierHierarchyFactory, createSourceVisitor, createTypeHierarchy, getQualifierHierarchy, getSupportedLintOptions, getSupportedTypeQualifiers, getTypeHierarchy, invokeConstructorFor

Methods inherited from class checkers.source.SourceChecker

errorAbort, errorAbort, formatStackTrace, fullMessageOf, getLintOption, getLintOption, getMessages, getProcessingEnvironment, getProperties, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, message, report, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, typeProcess, typeProcessingStart

Methods inherited from class checkers.source.AbstractTypeProcessor

init, process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized, toString

Methods inherited from class java.lang.Object

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

Field Detail

unitsRel

protected Map<@ReadOnly String,UnitsRelations> unitsRel

utils

protected AnnotationUtils utils

Constructor Detail

UnitsChecker

public UnitsChecker()

Method Detail

initChecker

public void initChecker()

Description copied from class: SourceChecker

Initialize the checker.

Overrides:

initChecker in class BaseTypeChecker

See Also:

AbstractProcessor.init(ProcessingEnvironment)

createSupportedTypeQualifiers

protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()

Copied from BasicChecker and adapted "quals" to "units".

Overrides:

createSupportedTypeQualifiers in class BaseTypeChecker

Returns:

the type qualifiers supported this processor, or an empty set if none

See Also:

TypeQualifiers

getSuppressWarningsKey

public Collection<@ReadOnly String> getSuppressWarningsKey()

Copied from BasicChecker; cannot reuse it, because BasicChecker is final. TODO: BasicChecker might also want to always call super.

Overrides:

getSuppressWarningsKey in class SourceChecker

Returns:

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

See Also:

SuppressWarningsKey

createQualifierHierarchy

public QualifierHierarchy createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Description copied from class: BaseTypeChecker

Factory method to easily change what QualifierHierarchy is created. Needs to be public only because the GraphFactory must be able to call this method. No external use of this method is necessary.

Overrides:

createQualifierHierarchy in class BaseTypeChecker