org.apache.lucene.search

Enum BooleanClause.Occur

    • Enum Constant Detail

      • MUST

        public static final BooleanClause.Occur MUST
        Use this operator for clauses that must appear in the matching documents.
      • MUST_NOT

        public static final BooleanClause.Occur MUST_NOT
        Use this operator for clauses that must not appear in the matching documents. Note that it is not possible to search for queries that only consist of a MUST_NOT clause. These clauses do not contribute to the score of documents.
    • Method Detail

      • values

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

        public static BooleanClause.Occur 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