Enum AnalysisMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AnalysisMode>, java.lang.constant.Constable

    public enum AnalysisMode
    extends java.lang.Enum<AnalysisMode>
    Enum representing the mode in which token filters and analyzers are allowed to operate. While most token filters are allowed both in index and search time analyzers, some are restricted to be used only at index time, others at search time.
    • Nested Class Summary

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

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      AnalysisMode representing analysis components that can be used both at index and search time
      INDEX_TIME
      AnalysisMode representing analysis components that can be used only at index time
      SEARCH_TIME
      AnalysisMode representing analysis components that can be used only at search time
    • Method Summary

      Modifier and Type Method Description
      java.lang.String getReadableName()  
      static AnalysisMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AnalysisMode[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • INDEX_TIME

        public static final AnalysisMode INDEX_TIME
        AnalysisMode representing analysis components that can be used only at index time
      • SEARCH_TIME

        public static final AnalysisMode SEARCH_TIME
        AnalysisMode representing analysis components that can be used only at search time
      • ALL

        public static final AnalysisMode ALL
        AnalysisMode representing analysis components that can be used both at index and search time
    • Method Detail

      • values

        public static AnalysisMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AnalysisMode 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
      • getReadableName

        public java.lang.String getReadableName()