checkers.units

Class UnitsRelationsDefault

@NonNull java.lang.Object

checkers.units.UnitsRelationsDefault

All Implemented Interfaces:

UnitsRelations

public class UnitsRelationsDefault
extends @NonNull Object
implements UnitsRelations

Default relations between SI units. TODO: what relations are missing?

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable AnnotationMirror	h
protected @Nullable AnnotationMirror	km
protected @Nullable AnnotationMirror	km2
protected @Nullable AnnotationMirror	kmPERh
protected @Nullable AnnotationMirror	m
protected @Nullable AnnotationMirror	m2
protected @Nullable AnnotationMirror	mPERs
protected @Nullable AnnotationMirror	s

Constructor Summary

Constructors

Constructor and Description
UnitsRelationsDefault()

Method Summary

Methods

Modifier and Type	Method and Description
@Nullable AnnotationMirror	division(@Mutable AnnotatedTypeMirror p1, @Mutable AnnotatedTypeMirror p2) Called for the division of type p1 and p2.
UnitsRelations	init(AnnotationUtils annos, ProcessingEnvironment env) Initialize the object.
@Nullable AnnotationMirror	multiplication(@Mutable AnnotatedTypeMirror p1, @Mutable AnnotatedTypeMirror p2) Called for the multiplication of type p1 and p2.

Methods inherited from class java.lang.Object

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

Field Detail

m

protected @Nullable AnnotationMirror m

km

protected @Nullable AnnotationMirror km

m2

protected @Nullable AnnotationMirror m2

km2

protected @Nullable AnnotationMirror km2

s

protected @Nullable AnnotationMirror s

h

protected @Nullable AnnotationMirror h

mPERs

protected @Nullable AnnotationMirror mPERs

kmPERh

protected @Nullable AnnotationMirror kmPERh

Constructor Detail

UnitsRelationsDefault

public UnitsRelationsDefault()

Method Detail

init

public UnitsRelations init(AnnotationUtils annos,
                  ProcessingEnvironment env)

Description copied from interface: UnitsRelations

Initialize the object. Needs to be called before any other method.

Specified by:

init in interface UnitsRelations

Parameters:

annos - The AnnotationUtils to use.

env - The ProcessingEnvironment to use.

Returns:

A reference to "this".

multiplication

public @Nullable AnnotationMirror multiplication(@Mutable AnnotatedTypeMirror p1,
                                        @Mutable AnnotatedTypeMirror p2)

Description copied from interface: UnitsRelations

Called for the multiplication of type p1 and p2.

Specified by:

multiplication in interface UnitsRelations

Parameters:

p1 - LHS in multiplication.

p2 - RHS in multiplication.

Returns:

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

division

public @Nullable AnnotationMirror division(@Mutable AnnotatedTypeMirror p1,
                                  @Mutable AnnotatedTypeMirror p2)

Description copied from interface: UnitsRelations

Called for the division of type p1 and p2.

Specified by:

division in interface UnitsRelations

Parameters:

p1 - LHS in division.

p2 - RHS in division.

Returns:

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