org.checkerframework.framework.stub

Enum AnnotationFileUtil.AnnotationFileType

java.lang.Object

java.lang.Enum<AnnotationFileUtil.AnnotationFileType>

org.checkerframework.framework.stub.AnnotationFileUtil.AnnotationFileType

All Implemented Interfaces:

Serializable, Comparable<AnnotationFileUtil.AnnotationFileType>

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".

Enum Constant Summary

Enum Constants

Enum Constant and 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 and 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 type with the specified name.
static AnnotationFileUtil.AnnotationFileType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static AnnotationFileUtil.AnnotationFileType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnnotationFileUtil.AnnotationFileType c : AnnotationFileUtil.AnnotationFileType.values())
    System.out.println(c);

Returns:

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

valueOf

public static AnnotationFileUtil.AnnotationFileType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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)