org.checkerframework.framework.stub

Class AnnotationFileParser.RecordStub

java.lang.Object

org.checkerframework.framework.stub.AnnotationFileParser.RecordStub

Enclosing class:

AnnotationFileParser

public static class AnnotationFileParser.RecordStub
extends Object

Information about a record from a stub file.

Field Summary

Fields

Modifier and Type	Field and Description
LinkedHashMap<String,AnnotationFileParser.RecordComponentStub>	componentsByName A map from name to record component.
@MonotonicNonNull List<AnnotatedTypeMirror>	componentsInCanonicalConstructor If the canonical constructor is given in the stubs, the annotated types (in component declaration order) for the constructor.

Constructor Summary

Constructors

Constructor and Description
RecordStub(LinkedHashMap<String,AnnotationFileParser.RecordComponentStub> componentsByName) Creates a new RecordStub.

Method Summary

Modifier and Type	Method and Description
List<AnnotatedTypeMirror>	getComponentsInCanonicalConstructor() Returns the annotated types for the parameters to the canonical constructor.

Methods inherited from class java.lang.Object

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

Field Detail

componentsByName

public final LinkedHashMap<String,AnnotationFileParser.RecordComponentStub> componentsByName

A map from name to record component. The iteration order is the order that they are declared in the record header.

componentsInCanonicalConstructor

public @MonotonicNonNull List<AnnotatedTypeMirror> componentsInCanonicalConstructor

If the canonical constructor is given in the stubs, the annotated types (in component declaration order) for the constructor. Null if not present in the stubs.

Constructor Detail

RecordStub

public RecordStub(LinkedHashMap<String,AnnotationFileParser.RecordComponentStub> componentsByName)

Creates a new RecordStub.

Parameters:

componentsByName - a map from name to record component. The insertion/iteration order is the order that they are declared in the record header.

Method Detail

getComponentsInCanonicalConstructor

public List<AnnotatedTypeMirror> getComponentsInCanonicalConstructor()

Returns the annotated types for the parameters to the canonical constructor. This is either from explicit annotations on the constructor in the stubs, otherwise it's taken from the annotations on the record components in the stubs.

Returns:

the annotated types for the parameters to the canonical constructor