Enum ScoreMode

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

    public enum ScoreMode
    extends java.lang.Enum<ScoreMode>
    Different modes of search.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMPLETE
      Produced scorers will allow visiting all matches and get their score.
      COMPLETE_NO_SCORES
      Produced scorers will allow visiting all matches but scores won't be available.
      TOP_SCORES
      Produced scorers will optionally allow skipping over non-competitive hits using the Scorable.setMinCompetitiveScore(float) API.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ScoreMode()  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract boolean needsScores()
      Whether this ScoreMode needs to compute scores.
      static ScoreMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ScoreMode[] 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

      • COMPLETE

        public static final ScoreMode COMPLETE
        Produced scorers will allow visiting all matches and get their score.
      • COMPLETE_NO_SCORES

        public static final ScoreMode COMPLETE_NO_SCORES
        Produced scorers will allow visiting all matches but scores won't be available.
    • Constructor Detail

      • ScoreMode

        private ScoreMode()
    • Method Detail

      • values

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

        public static ScoreMode 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
      • needsScores

        public abstract boolean needsScores()
        Whether this ScoreMode needs to compute scores.