パッケージ jakarta.mail

クラス Flags

  • 実装されたすべてのインターフェース:
    SerializableSE, CloneableSE
    public class Flags
extends ObjectSE
implements CloneableSE, SerializableSE
    Flags クラスは、メッセージのフラグのセットを表します。フラグは、事前定義されたシステムフラグとユーザー定義のフラグで構成されます。

    システムフラグは、Flags.Flag 内部クラスによって表されます。ユーザー定義フラグは文字列として表されます。ユーザーフラグは大文字と小文字が区別されません。

    標準のシステムフラグのセットが事前定義されています。ほとんどのフォルダー実装は、これらのフラグをサポートすることが期待されています。一部の実装では、任意のユーザー定義フラグもサポートされる場合があります。フォルダーの getPermanentFlags メソッドは、そのフォルダーの実装でサポートされているすべてのフラグを保持する Flags オブジェクトを返します。

    Flags オブジェクトは直列化できるため、（たとえば）検索語での Flags オブジェクトの使用を検索語とともに直列化できます。

    警告 : このクラスの直列化されたオブジェクトは、将来の Jakarta Mail API リリースと互換性がない可能性があります。現在の直列化サポートは、短期間の保管に適しています。

    以下のコードサンプルは、メッセージのフラグを設定、調査、取得する方法を示しています。

    
 Message m = folder.getMessage(1);
 m.setFlag(Flags.Flag.DELETED, true); // set the DELETED flag

 // Check if DELETED flag is set on this message
 if (m.isSet(Flags.Flag.DELETED))
        System.out.println("DELETED message");

 // Examine ALL system flags for this message
 Flags flags = m.getFlags();
 Flags.Flag[] sf = flags.getSystemFlags();
 for (int i = 0; i < sf.length; i++) {
        if (sf[i] == Flags.Flag.DELETED)
            System.out.println("DELETED message");
        else if (sf[i] == Flags.Flag.SEEN)
            System.out.println("SEEN message");
      ......
      ......
 }

    作成者:
    John Mani, Bill Shannon
    関連事項:
    Folder.getPermanentFlags(), 直列化された形式

    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 クラス 説明
      static class Flags.Flag
      この内部クラスは、個々のシステムフラグを表します。

    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      Flags()
      空の Flags オブジェクトを作成します。
      Flags​(Flags flags)
      指定されたフラグで初期化された Flags オブジェクトを作成します。
      Flags​(Flags.Flag flag)
      指定されたシステムフラグで初期化された Flags オブジェクトを作成します。
      Flags​(StringSE flag)
      指定されたユーザーフラグで初期化された Flags オブジェクトを作成します。

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   具象メソッド  
      修飾子と型 メソッド 説明
      voidadd​(Flags f)
      指定された Flags オブジェクトのすべてのフラグをこの Flags オブジェクトに追加します。
      voidadd​(Flags.Flag flag)
      指定されたシステムフラグをこの Flags オブジェクトに追加します。
      voidadd​(StringSE flag)
      指定されたユーザーフラグをこの Flags オブジェクトに追加します。
      voidclearSystemFlags()
      すべてのシステムフラグをクリアします。
      voidclearUserFlags()
      すべてのユーザーフラグをクリアします。
      ObjectSEclone()
      この Flags オブジェクトのクローンを返します。
      booleancontains​(Flags f)
      指定された Flags オブジェクトのすべてのフラグがこの Flags オブジェクトに存在するかどうかを確認します。
      booleancontains​(Flags.Flag flag)
      指定されたシステムフラグがこの Flags オブジェクトに存在するかどうかを確認します。
      booleancontains​(StringSE flag)
      指定されたユーザーフラグがこの Flags オブジェクトに存在するかどうかを確認します。
      booleanequals​(ObjectSE obj)
      2 つの Flags オブジェクトが等しいかどうかを確認します。
      Flags.Flag[]getSystemFlags()
      この Flags オブジェクトのすべてのシステムフラグを返します。
      StringSE[]getUserFlags()
      この Flags オブジェクト内のすべてのユーザーフラグを返します。
      inthashCode()
      この Flags オブジェクトのハッシュコードを計算します。
      voidremove​(Flags f)
      指定された Flags オブジェクト内のすべてのフラグをこの Flags オブジェクトから削除します。
      voidremove​(Flags.Flag flag)
      この Flags オブジェクトから指定されたシステムフラグを削除します。
      voidremove​(StringSE flag)
      この Flags オブジェクトから指定されたユーザーフラグを削除します。
      booleanretainAll​(Flags f)
      指定された Flags オブジェクトにないフラグをすべて削除します。
      StringSEtoString()
      この Flags オブジェクトの文字列表現を返します。

    • コンストラクターの詳細

      • Flags

        public Flags()
        空の Flags オブジェクトを作成します。

      • Flags

        public Flags​(Flags flags)
        指定されたフラグで初期化された Flags オブジェクトを作成します。
        パラメーター:
        flags - 初期化のフラグ

      • Flags

        public Flags​(Flags.Flag flag)
        指定されたシステムフラグで初期化された Flags オブジェクトを作成します。
        パラメーター:
        flag - 初期化のフラグ

      • Flags

        public Flags​(StringSE flag)
        指定されたユーザーフラグで初期化された Flags オブジェクトを作成します。
        パラメーター:
        flag - 初期化のフラグ

    • メソッドの詳細

      • add

        public void add​(Flags.Flag flag)
        指定されたシステムフラグをこの Flags オブジェクトに追加します。
        パラメーター:
        flag - 追加するフラグ

      • add

        public void add​(StringSE flag)
        指定されたユーザーフラグをこの Flags オブジェクトに追加します。
        パラメーター:
        flag - 追加するフラグ

      • add

        public void add​(Flags f)
        指定された Flags オブジェクトのすべてのフラグをこの Flags オブジェクトに追加します。
        パラメーター:
        f - フラグオブジェクト

      • remove

        public void remove​(Flags.Flag flag)
        この Flags オブジェクトから指定されたシステムフラグを削除します。
        パラメーター:
        flag - 削除するフラグ

      • remove

        public void remove​(StringSE flag)
        この Flags オブジェクトから指定されたユーザーフラグを削除します。
        パラメーター:
        flag - 削除するフラグ

      • remove

        public void remove​(Flags f)
        指定された Flags オブジェクト内のすべてのフラグをこの Flags オブジェクトから削除します。
        パラメーター:
        f - 削除するフラグ

      • retainAll

        public boolean retainAll​(Flags f)
        指定された Flags オブジェクトにないフラグをすべて削除します。サーバーでサポートされていないフラグをクリアできます。指定された Flags オブジェクトに Flags.Flag.USER フラグが含まれている場合、この Flags オブジェクト内のすべてのユーザーフラグが保持されます。
        パラメーター:
        f - 保持するフラグ
        戻り値:
        この Flags オブジェクトが変更された場合は true
        導入:
        JavaMail 1.6

      • contains

        public boolean contains​(Flags.Flag flag)
        指定されたシステムフラグがこの Flags オブジェクトに存在するかどうかを確認します。
        パラメーター:
        flag - テストするフラグ
        戻り値:
        指定されたフラグの true が存在し、それ以外の場合は false です。

      • contains

        public boolean contains​(StringSE flag)
        指定されたユーザーフラグがこの Flags オブジェクトに存在するかどうかを確認します。
        パラメーター:
        flag - テストするフラグ
        戻り値:
        指定されたフラグの true が存在し、それ以外の場合は false です。

      • contains

        public boolean contains​(Flags f)
        指定された Flags オブジェクトのすべてのフラグがこの Flags オブジェクトに存在するかどうかを確認します。
        パラメーター:
        f - テストするフラグ
        戻り値:
        指定された Flags オブジェクト内のすべてのフラグが存在する場合は true、それ以外の場合は false。

      • equals

        public boolean equals​(ObjectSE obj)
        2 つの Flags オブジェクトが等しいかどうかを確認します。
        オーバーライド:
        クラス ObjectSE の equalsSE 
        戻り値:
        それらが等しい場合は true

      • hashCode

        public int hashCode()
        この Flags オブジェクトのハッシュコードを計算します。
        オーバーライド:
        クラス ObjectSE の hashCode 
        戻り値:
        ハッシュコード

      • getSystemFlags

        public Flags.Flag[] getSystemFlags()
        この Flags オブジェクトのすべてのシステムフラグを返します。フラグが設定されていない場合、サイズ 0 の配列を返します。
        戻り値:
        システムフラグを表す Flags.Flag オブジェクトの配列

      • getUserFlags

        public StringSE[] getUserFlags()
        この Flags オブジェクト内のすべてのユーザーフラグを返します。フラグが設定されていない場合、サイズ 0 の配列を返します。
        戻り値:
        文字列の配列。各文字列はフラグを表します。

      • clearSystemFlags

        public void clearSystemFlags()
        すべてのシステムフラグをクリアします。
        導入:
        JavaMail 1.6

      • clearUserFlags

        public void clearUserFlags()
        すべてのユーザーフラグをクリアします。
        導入:
        JavaMail 1.6

      • clone

        public ObjectSE clone()
        この Flags オブジェクトのクローンを返します。
        オーバーライド:
        クラス ObjectSE の clone 

      • toString

        public StringSE toString()
        この Flags オブジェクトの文字列表現を返します。文字列の正確な形式は変更される可能性があることに注意してください。
        オーバーライド:
        クラス ObjectSE の toString