Package javax.mail

Class Flags

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class Flags
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
    The set of flags on a message. Flags are composed of predefined system flags (Flags.Flag), and user defined flags (case-independent String).
    Version:
    1.4
    Author:
    Chris Burdess
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Flags.Flag
      An individual system flag.

    • Constructor Summary

      Constructors 
      Constructor Description
      Flags()
      Construct an empty Flags object.
      Flags​(java.lang.String flag)
      Construct a Flags object containing the given user flag.
      Flags​(Flags flags)
      Construct a Flags object containing the given flags.
      Flags​(Flags.Flag flag)
      Construct a Flags object containing the given system flag.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(java.lang.String flag)
      Add the specified user flag.
      void add​(Flags flags)
      Add all the flags from the specified Flags object.
      void add​(Flags.Flag flag)
      Add the specified system flag.
      java.lang.Object clone()  
      boolean contains​(java.lang.String flag)
      Indicates whether the specified user flag is set.
      boolean contains​(Flags flags)
      Indicates whether all the flags in the specified Flags object are set in this Flags object.
      boolean contains​(Flags.Flag flag)
      Indicates whether the specified system flag is set.
      boolean equals​(java.lang.Object other)  
      Flags.Flag[] getSystemFlags()
      Returns the system flags.
      java.lang.String[] getUserFlags()
      Returns the user flags.
      int hashCode()  
      void remove​(java.lang.String flag)
      Remove the specified user flag.
      void remove​(Flags flags)
      Remove all flags in the given Flags object from this Flags object.
      void remove​(Flags.Flag flag)
      Remove the specified system flag.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Flags

        public Flags()
        Construct an empty Flags object.

      • Flags

        public Flags​(Flags flags)
        Construct a Flags object containing the given flags.

      • Flags

        public Flags​(Flags.Flag flag)
        Construct a Flags object containing the given system flag.

      • Flags

        public Flags​(java.lang.String flag)
        Construct a Flags object containing the given user flag.

    • Method Detail

      • add

        public void add​(Flags.Flag flag)
        Add the specified system flag.

      • add

        public void add​(java.lang.String flag)
        Add the specified user flag.

      • add

        public void add​(Flags flags)
        Add all the flags from the specified Flags object.

      • remove

        public void remove​(Flags.Flag flag)
        Remove the specified system flag.

      • remove

        public void remove​(java.lang.String flag)
        Remove the specified user flag.

      • remove

        public void remove​(Flags flags)
        Remove all flags in the given Flags object from this Flags object.

      • contains

        public boolean contains​(Flags.Flag flag)
        Indicates whether the specified system flag is set.

      • contains

        public boolean contains​(java.lang.String flag)
        Indicates whether the specified user flag is set.

      • contains

        public boolean contains​(Flags flags)
        Indicates whether all the flags in the specified Flags object are set in this Flags object.

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getSystemFlags

        public Flags.Flag[] getSystemFlags()
        Returns the system flags.

      • getUserFlags

        public java.lang.String[] getUserFlags()
        Returns the user flags.

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object