Class FlagTerm

java.lang.Object
jakarta.mail.search.SearchTerm
jakarta.mail.search.FlagTerm
All Implemented Interfaces:
Serializable

public final class FlagTerm extends SearchTerm
This class implements comparisons for Message Flags.
See Also:
  • Constructor Details

    • FlagTerm

      public FlagTerm(Flags flags, boolean set)
      Constructor.
      Parameters:
      flags - Flags object containing the flags to check for
      set - the flag setting to check for
  • Method Details

    • getFlags

      public Flags getFlags()
      Return the Flags to test.
      Returns:
      the flags
    • getTestSet

      public boolean getTestSet()
      Return true if testing whether the flags are set.
      Returns:
      true if testing whether the flags are set
    • match

      public boolean match(Message msg)
      The comparison method.
      Specified by:
      match in class SearchTerm
      Parameters:
      msg - The flag comparison is applied to this Message
      Returns:
      true if the comparson succeeds, otherwise false.
    • equals

      public boolean equals(Object obj)
      Equality comparison.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Compute a hashCode for this object.
      Overrides:
      hashCode in class Object