checkers.units

Interface UnitsRelations

All Known Implementing Classes:

UnitsRelationsDefault

public interface UnitsRelations

Interface that is used to specify the relation between units.

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.

Method Detail

init

UnitsRelations init(AnnotationUtils annos,
                  ProcessingEnvironment env)

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

Parameters:

annos - The AnnotationUtils to use.

env - The ProcessingEnvironment to use.

Returns:

A reference to "this".

multiplication

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

Called for the multiplication of type p1 and p2.

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

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

Called for the division of type p1 and p2.

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.