Enum SearchOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SearchOption>

    @API(status=STABLE,
         since="1.10")
    public enum SearchOption
    extends java.lang.Enum<SearchOption>
    Search options for finding an annotation within a class hierarchy.
    Since:
    1.8
    See Also:
    DEFAULT, INCLUDE_ENCLOSING_CLASSES
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Search the inheritance hierarchy (i.e., the current class, implemented interfaces, and superclasses), but do not search on enclosing classes.
      INCLUDE_ENCLOSING_CLASSES
      Search the inheritance hierarchy as with the DEFAULT search option but also search the enclosing class hierarchy for inner classes (i.e., a non-static member classes).
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SearchOption()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SearchOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SearchOption[] 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

      • DEFAULT

        public static final SearchOption DEFAULT
        Search the inheritance hierarchy (i.e., the current class, implemented interfaces, and superclasses), but do not search on enclosing classes.
        See Also:
        Class.getSuperclass(), Class.getInterfaces()
      • INCLUDE_ENCLOSING_CLASSES

        public static final SearchOption INCLUDE_ENCLOSING_CLASSES
        Search the inheritance hierarchy as with the DEFAULT search option but also search the enclosing class hierarchy for inner classes (i.e., a non-static member classes).
    • Constructor Detail

      • SearchOption

        private SearchOption()
    • Method Detail

      • values

        public static SearchOption[] 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 (SearchOption c : SearchOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SearchOption 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