edu.umd.cs.findbugs.ba.jsr305

Class TypeQualifierAnnotationLookupResult

java.lang.Object

edu.umd.cs.findbugs.ba.jsr305.TypeQualifierAnnotationLookupResult

public class TypeQualifierAnnotationLookupResult
extends Object

The result of looking up a TypeQualifierAnnotation. Because type qualifiers are inherited, a full result of looking resolving a TypeQualifierAnnotation may include annotations on one or more supertypes. Potentially, the supertype annotations may conflict with each other, and/or conflict with the annotation on the annotated entity. This object makes it possible to report such conflicts, while still providing a convenient interface for getting the "effective" TypeQualifierAnnotation.

Author:

David Hovemeyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeQualifierAnnotationLookupResult.PartialResult Partial result of looking up a TypeQualifierAnnotation.

Method Summary

Methods

Modifier and Type	Method and Description
protected TypeQualifierAnnotation	combine(TypeQualifierAnnotation a, TypeQualifierAnnotation b) Subclasses must override this method to combine TypeQualifierAnnotations found in multiple superclasses.
TypeQualifierAnnotation	getEffectiveTypeQualifierAnnotation() Get the effective TypeQualifierAnnotation.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getEffectiveTypeQualifierAnnotation

@CheckForNull
public TypeQualifierAnnotation getEffectiveTypeQualifierAnnotation()

Get the effective TypeQualifierAnnotation.

Returns:

the effective TypeQualifierAnnotation, or null if no effective TypeQualifierAnnotation can be found

combine

protected TypeQualifierAnnotation combine(TypeQualifierAnnotation a,
                              TypeQualifierAnnotation b)

Subclasses must override this method to combine TypeQualifierAnnotations found in multiple superclasses.

Parameters:

a - a TypeQualifierAnnotation

b - another TypeQualifierAnnotation

Returns:

combined TypeQualifierAnnotation compatible with both input TypeQualifierAnnotations, or null if no such TypeQualifierAnnotation exists

toString

public String toString()

Overrides:

toString in class Object