org.checkerframework.checker.units

Class UnitsRelationsDefault

java.lang.Object

org.checkerframework.checker.units.UnitsRelationsDefault

All Implemented Interfaces:

UnitsRelations

public class UnitsRelationsDefault
extends java.lang.Object
implements UnitsRelations

Default relations between SI units.

TODO: what relations are missing?

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.lang.model.util.Elements	elements The Element Utilities from the Units Checker's processing environment.
protected javax.lang.model.element.AnnotationMirror	h SI units.
protected javax.lang.model.element.AnnotationMirror	km SI units.
protected javax.lang.model.element.AnnotationMirror	km2 SI units.
protected javax.lang.model.element.AnnotationMirror	kmPERh SI units.
protected javax.lang.model.element.AnnotationMirror	m SI units.
protected javax.lang.model.element.AnnotationMirror	m2 SI units.
protected javax.lang.model.element.AnnotationMirror	mm SI units.
protected javax.lang.model.element.AnnotationMirror	mm2 SI units.
protected javax.lang.model.element.AnnotationMirror	mPERs SI units.
protected javax.lang.model.element.AnnotationMirror	mPERs2 SI units.
protected javax.lang.model.element.AnnotationMirror	s SI units.

Constructor Summary

Constructors

Constructor and Description
UnitsRelationsDefault()

Method Summary

Modifier and Type	Method and Description
protected boolean	bothHaveSpecificPrefix(Prefix lhtPrefix, Prefix rhtPrefix, Prefix specificPrefix) Checks to see if both lhtPrefix and rhtPrefix have the same prefix as specificPrefix.
@Nullable javax.lang.model.element.AnnotationMirror	division(AnnotatedTypeMirror lht, AnnotatedTypeMirror rht) Provides rules for resolving the result Unit of the division of checker-framework provided Units.
protected boolean	havePairOfUnits(AnnotatedTypeMirror lht, javax.lang.model.element.AnnotationMirror ul, AnnotatedTypeMirror rht, javax.lang.model.element.AnnotationMirror ur) Checks to see if lht has the unit ul and if rht has the unit ur all at the same time.
protected boolean	havePairOfUnitsIgnoringOrder(AnnotatedTypeMirror lht, javax.lang.model.element.AnnotationMirror u1, AnnotatedTypeMirror rht, javax.lang.model.element.AnnotationMirror u2) Checks to see if lht and rht have the pair of units u1 and u2 regardless of order.
UnitsRelations	init(javax.annotation.processing.ProcessingEnvironment env) Constructs various AnnotationMirrors representing specific checker-framework provided Units involved in the rules resolved in this UnitsRelations implementation.
@Nullable javax.lang.model.element.AnnotationMirror	multiplication(AnnotatedTypeMirror lht, AnnotatedTypeMirror rht) Provides rules for resolving the result Unit of the multiplication of checker-framework provided Units.

Methods inherited from class java.lang.Object

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

Field Detail

m

protected javax.lang.model.element.AnnotationMirror m

SI units.

km

protected javax.lang.model.element.AnnotationMirror km

SI units.

mm

protected javax.lang.model.element.AnnotationMirror mm

SI units.

m2

protected javax.lang.model.element.AnnotationMirror m2

SI units.

km2

protected javax.lang.model.element.AnnotationMirror km2

SI units.

mm2

protected javax.lang.model.element.AnnotationMirror mm2

SI units.

s

protected javax.lang.model.element.AnnotationMirror s

SI units.

h

protected javax.lang.model.element.AnnotationMirror h

SI units.

mPERs

protected javax.lang.model.element.AnnotationMirror mPERs

SI units.

kmPERh

protected javax.lang.model.element.AnnotationMirror kmPERh

SI units.

mPERs2

protected javax.lang.model.element.AnnotationMirror mPERs2

SI units.

elements

protected javax.lang.model.util.Elements elements

The Element Utilities from the Units Checker's processing environment.

Constructor Detail

UnitsRelationsDefault

public UnitsRelationsDefault()

Method Detail

init

public UnitsRelations init(javax.annotation.processing.ProcessingEnvironment env)

Constructs various AnnotationMirrors representing specific checker-framework provided Units involved in the rules resolved in this UnitsRelations implementation.

Specified by:

init in interface UnitsRelations

Parameters:

env - the ProcessingEnvironment to use

Returns:

a reference to "this"

multiplication

public @Nullable javax.lang.model.element.AnnotationMirror multiplication(AnnotatedTypeMirror lht,
                                                                          AnnotatedTypeMirror rht)

Provides rules for resolving the result Unit of the multiplication of checker-framework provided Units.

Specified by:

multiplication in interface UnitsRelations

Parameters:

lht - left hand side in multiplication

rht - right hand side in multiplication

Returns:

the annotation to use for the result of the multiplication or null if no special relation is known

division

public @Nullable javax.lang.model.element.AnnotationMirror division(AnnotatedTypeMirror lht,
                                                                    AnnotatedTypeMirror rht)

Provides rules for resolving the result Unit of the division of checker-framework provided Units.

Specified by:

division in interface UnitsRelations

Parameters:

lht - left hand side in division

rht - right hand side in division

Returns:

the annotation to use for the result of the division or null if no special relation is known

bothHaveSpecificPrefix

protected boolean bothHaveSpecificPrefix(Prefix lhtPrefix,
                                         Prefix rhtPrefix,
                                         Prefix specificPrefix)

Checks to see if both lhtPrefix and rhtPrefix have the same prefix as specificPrefix.

Parameters:

lhtPrefix - left hand side prefix

rhtPrefix - right hand side prefix

specificPrefix - specific desired prefix to match

Returns:

true if all 3 Prefix are the same, false otherwise

havePairOfUnits

protected boolean havePairOfUnits(AnnotatedTypeMirror lht,
                                  javax.lang.model.element.AnnotationMirror ul,
                                  AnnotatedTypeMirror rht,
                                  javax.lang.model.element.AnnotationMirror ur)

Checks to see if lht has the unit ul and if rht has the unit ur all at the same time.

Parameters:

lht - left hand annotated type

ul - left hand unit

rht - right hand annotated type

ur - right hand unit

Returns:

true if lht has lu and rht has ru, false otherwise

havePairOfUnitsIgnoringOrder

protected boolean havePairOfUnitsIgnoringOrder(AnnotatedTypeMirror lht,
                                               javax.lang.model.element.AnnotationMirror u1,
                                               AnnotatedTypeMirror rht,
                                               javax.lang.model.element.AnnotationMirror u2)

Checks to see if lht and rht have the pair of units u1 and u2 regardless of order.

Parameters:

lht - left hand annotated type

u1 - unit 1

rht - right hand annotated type

u2 - unit 2

Returns:

true if lht and rht have the pair of units u1 and u2 regardless of order, false otherwise