Package org.checkerframework.framework.stub

Enum Class AnnotationFileUtil.AnnotationFileType

java.lang.Object

java.lang.Enum<AnnotationFileUtil.AnnotationFileType>

org.checkerframework.framework.stub.AnnotationFileUtil.AnnotationFileType

All Implemented Interfaces:

Serializable, Comparable<AnnotationFileUtil.AnnotationFileType>, Constable

Enclosing class:

AnnotationFileUtil

public static enum AnnotationFileUtil.AnnotationFileType
extends Enum<AnnotationFileUtil.AnnotationFileType>

The types of files that can contain annotations. Also indicates the file's source, such as from the JDK, built in, or from the command line.

Stub files have extension ".astub". Ajava files have extension ".ajava".

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AJAVA	Ajava file provided on command line.
AJAVA_AS_STUB	Ajava file being parsed as if it is a stub file.
BUILTIN_STUB	Stub file built into a checker.
COMMAND_LINE_STUB	Stub file provided on command line.
JDK_STUB	Stub file in the annotated JDK.

Method Summary

Modifier and Type	Method	Description
boolean	isBuiltIn()	Returns true if this annotation file is built-in (not provided on the command line).
boolean	isCommandLine()	Returns true if this annotation file was provided on the command line (not built-in).
boolean	isStub()	Returns true if this represents a stub file.
static AnnotationFileUtil.AnnotationFileType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnnotationFileUtil.AnnotationFileType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

JDK_STUB

public static final AnnotationFileUtil.AnnotationFileType JDK_STUB

Stub file in the annotated JDK.

BUILTIN_STUB

public static final AnnotationFileUtil.AnnotationFileType BUILTIN_STUB

Stub file built into a checker.

COMMAND_LINE_STUB

public static final AnnotationFileUtil.AnnotationFileType COMMAND_LINE_STUB

Stub file provided on command line.

AJAVA_AS_STUB

public static final AnnotationFileUtil.AnnotationFileType AJAVA_AS_STUB

Ajava file being parsed as if it is a stub file.

AJAVA

public static final AnnotationFileUtil.AnnotationFileType AJAVA

Ajava file provided on command line.

Method Details

values

public static AnnotationFileUtil.AnnotationFileType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AnnotationFileUtil.AnnotationFileType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isStub

public boolean isStub()

Returns true if this represents a stub file.

Returns:

true if this represents a stub file

isBuiltIn

public boolean isBuiltIn()

Returns true if this annotation file is built-in (not provided on the command line).

Returns:

true if this annotation file is built-in (not provided on the command line)

isCommandLine

public boolean isCommandLine()

Returns true if this annotation file was provided on the command line (not built-in).

Returns:

true if this annotation file was provided on the command line (not built-in)