org.checkerframework.framework.util

Class FieldInvariants

java.lang.Object

org.checkerframework.framework.util.FieldInvariants

public class FieldInvariants
extends Object

Represents field invariants. A list of fields that have a specific qualifier in a class where these field invariants apply.

Constructor Summary

Constructors

Constructor and Description
FieldInvariants(FieldInvariants other, List<String> fields, List<AnnotationMirror> qualifiers) Creates a new object with all the invariant in other, plus those specified by fields and qualifiers.
FieldInvariants(List<String> fields, List<AnnotationMirror> qualifiers)

Method Summary

Modifier and Type	Method and Description
List<String>	getFields()
List<AnnotationMirror>	getQualifiersFor(CharSequence field) Returns a list of qualifiers for field.
Result	isSuperInvariant(FieldInvariants superInvar, AnnotatedTypeFactory factory)
boolean	isWellFormed()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldInvariants

public FieldInvariants(List<String> fields,
                       List<AnnotationMirror> qualifiers)

FieldInvariants

public FieldInvariants(FieldInvariants other,
                       List<String> fields,
                       List<AnnotationMirror> qualifiers)

Creates a new object with all the invariant in other, plus those specified by fields and qualifiers.

Parameters:

other - other invariant object, may be null

fields - list of fields

qualifiers - list of qualifiers

Method Detail

getFields

public List<String> getFields()

getQualifiersFor

public List<AnnotationMirror> getQualifiersFor(CharSequence field)

Returns a list of qualifiers for field. If field has no qualifiers, then the empty list is returned.

Parameters:

field - simple field name

Returns:

a list of qualifiers for field

isWellFormed

public boolean isWellFormed()

Returns:

whether or not there is a qualifier for each field

isSuperInvariant

public Result isSuperInvariant(FieldInvariants superInvar,
                               AnnotatedTypeFactory factory)

Returns:

null if superInvar is a super invariant, otherwise returns a Result with the error message