Enum AnnotationFileUtil.AnnotationFileType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AnnotationFileUtil.AnnotationFileType>
    Enclosing class:
    AnnotationFileUtil

    public static enum AnnotationFileUtil.AnnotationFileType
    extends java.lang.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 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

      All Methods Static Methods Instance Methods Concrete Methods 
      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​(java.lang.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
    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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)