checkers.util
Class GraphQualifierHierarchy

java.lang.Object
  checkers.types.QualifierHierarchy
      checkers.util.GraphQualifierHierarchy

public class GraphQualifierHierarchy
extends QualifierHierarchy

Represents the type qualifier hierarchy of a type system. It uses a an internal graph to represent the hierarchy. In addition to simply representing qualifiers, this implementation allows for two special qualifiers:

• Root qualifier: a qualifier that is a super qualifier of all other types in the hierarchy. One doesn't need to declare all of its relations.
• Wildcard qualifier: a qualifier that matches any other type. In other words is a sub and super of qualifiers.

Constructor Summary

GraphQualifierHierarchy()
Constructs an instance of GraphQualifierHierarchy with no qualifier (i.e.

GraphQualifierHierarchy(AnnotationMirror root)
Initialize an instance with the provided annotation being the root annotation in the hierarchy

Method Summary

void	addSubtype(AnnotationMirror subAnno, AnnotationMirror superAnno) Adds a subtype relationship between two type qualifiers.
boolean	addTypeQualifier(AnnotationMirror anno) Add a type qualifier to the type hierarchy
AnnotationMirror	getRootAnnotation()
Set<Name>	getTypeQualifiers() Returns the names of all type qualifiers in this type qualifier hierarchy
boolean	inConflict(AnnotationMirror a1, AnnotationMirror a2) Check if the two annotations are in conflict.
boolean	isSubtype(AnnotationMirror sub, AnnotationMirror sup) Tests whether anno1 is a super qualifier anno2, according to the type qualifiers hierarchy.
void	setRootAnnotation(AnnotationMirror root) Set the root type qualifier of the represented hierarchy
void	setWildcard(AnnotationMirror placeHolder) Declare a wildcard annotation that matches all annotations

Methods inherited from class checkers.types.QualifierHierarchy

isSubtype, validQualifier, validQualifiers

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphQualifierHierarchy

public GraphQualifierHierarchy()

Constructs an instance of GraphQualifierHierarchy with no qualifier (i.e. null) being the root qualifier

GraphQualifierHierarchy

public GraphQualifierHierarchy(AnnotationMirror root)

Initialize an instance with the provided annotation being the root annotation in the hierarchy

Parameters:

root - the type qualifier that is the supertype of all other qualifiers

Method Detail

addTypeQualifier

public boolean addTypeQualifier(AnnotationMirror anno)

Add a type qualifier to the type hierarchy

Parameters:

anno - a type qualifier

Returns:

true if is added to the hierarchy graph, false if it's already in the hierarchy graph

addSubtype

public void addSubtype(AnnotationMirror subAnno,
                       AnnotationMirror superAnno)

Adds a subtype relationship between two type qualifiers. One does not need to declare subtyping relations to the root or placeholder type qualifiers.

Parameters:

subAnno - the sub type qualifier

superAnno - the super type qualifier

getRootAnnotation

public AnnotationMirror getRootAnnotation()

Specified by:

getRootAnnotation in class QualifierHierarchy

Returns:

the root (ultimate super) type qualifier in the hierarchy

setRootAnnotation

public void setRootAnnotation(AnnotationMirror root)

Set the root type qualifier of the represented hierarchy

Parameters:

root - the root (the ultimate super) type qualifier

setWildcard

public void setWildcard(AnnotationMirror placeHolder)

Declare a wildcard annotation that matches all annotations

Parameters:

placeHolder - the place holder annotation

isSubtype

public boolean isSubtype(AnnotationMirror sub,
                         AnnotationMirror sup)

Description copied from class: QualifierHierarchy

Tests whether anno1 is a super qualifier anno2, according to the type qualifiers hierarchy.

Specified by:

isSubtype in class QualifierHierarchy

Returns:

true iff anno1 is a sub qualifier of anno2

getTypeQualifiers

public Set<Name> getTypeQualifiers()

Description copied from class: QualifierHierarchy

Returns the names of all type qualifiers in this type qualifier hierarchy

Specified by:

getTypeQualifiers in class QualifierHierarchy

Returns:

the fully qualified name represented in this hierarchy

inConflict

public boolean inConflict(AnnotationMirror a1,
                          AnnotationMirror a2)

Description copied from class: QualifierHierarchy

Check if the two annotations are in conflict. Two qualifiers are in conflict if both cannot annotate a type together.

Specified by:

inConflict in class QualifierHierarchy

Returns:

true iff anno1 and anno2 are in conflict