edu.umd.cs.findbugs.ba.jsr305

Class TypeQualifierAnnotation

java.lang.Object

edu.umd.cs.findbugs.ba.jsr305.TypeQualifierAnnotation

public class TypeQualifierAnnotation
extends java.lang.Object

A type qualifier applied to a field, method, parameter, or return value.

Author:

Bill Pugh, David Hovemeyer

Field Summary

Fields

Modifier and Type	Field and Description
static TypeQualifierAnnotation	OVERRIDES_BUT_NO_ANNOTATION
TypeQualifierValue<?>	typeQualifier
javax.annotation.meta.When	when

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearInstance()
static TypeQualifierAnnotation	combineParameterAnnotations(TypeQualifierAnnotation a, TypeQualifierAnnotation b)
static TypeQualifierAnnotation	combineReturnTypeAnnotations(TypeQualifierAnnotation a, TypeQualifierAnnotation b) Combine return type annotations.
boolean	equals(java.lang.Object o)
static TypeQualifierAnnotation	getValue(TypeQualifierValue<?> desc, javax.annotation.meta.When when)
static java.util.Collection<TypeQualifierAnnotation>	getValues(java.util.Map<TypeQualifierValue<?>,javax.annotation.meta.When> map)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

typeQualifier

public final TypeQualifierValue<?> typeQualifier

when

public final javax.annotation.meta.When when

OVERRIDES_BUT_NO_ANNOTATION

public static final TypeQualifierAnnotation OVERRIDES_BUT_NO_ANNOTATION

Method Detail

clearInstance

public static void clearInstance()

combineReturnTypeAnnotations

@CheckForNull
public static TypeQualifierAnnotation combineReturnTypeAnnotations(TypeQualifierAnnotation a,
                                                                TypeQualifierAnnotation b)

Combine return type annotations.

Parameters:

a - a TypeQualifierAnnotation used on a return value

b - another TypeQualifierAnnotation used on a return value

Returns:

combined return type annotation that is at least as narrow as both a or b, or null if no such TypeQualifierAnnotation exists

combineParameterAnnotations

@Nonnull
public static TypeQualifierAnnotation combineParameterAnnotations(TypeQualifierAnnotation a,
                                                          TypeQualifierAnnotation b)

Parameters:

a - a TypeQualifierAnnotation used on a method parameter

b - another TypeQualifierAnnotation used on a method parameter

Returns:

combined parameter annotation that is at least as wide as both a and b

getValues

@Nonnull
public static java.util.Collection<TypeQualifierAnnotation> getValues(java.util.Map<TypeQualifierValue<?>,javax.annotation.meta.When> map)

getValue

@Nonnull
public static TypeQualifierAnnotation getValue(TypeQualifierValue<?> desc,
                                       javax.annotation.meta.When when)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object