Java列挙型を使用したビットフィールドの実装

StackOverflow https://stackoverflow.com/questions/5346477

  •  27-10-2019
  •  | 
  •  

質問

私は大規模なドキュメント アーカイブを管理しており、ドキュメントの処理中または検証時にビット フィールドを使用してドキュメントのステータスを記録することがよくあります。私の従来のコードでは、単に次のような静的な int 定数を使用しています。

static int DOCUMENT_STATUS_NO_STATE = 0
static int DOCUMENT_STATUS_OK = 1
static int DOCUMENT_STATUS_NO_TIF_FILE = 2
static int DOCUMENT_STATUS_NO_PDF_FILE = 4

これにより、適切なフラグを設定することで、ドキュメントの状態を示すことが非常に簡単になります。例えば： 

status = DOCUMENT_STATUS_NO_TIF_FILE | DOCUMENT_STATUS_NO_PDF_FILE;

静的定数を使用するアプローチは悪い習慣であり、コードを改善したいため、同じことを達成するために列挙型を使用することを検討していました。いくつかの要件があります。そのうちの 1 つは、ステータスを数値タイプとしてデータベースに保存する必要があることです。したがって、列挙定数を数値に変換する必要があります。以下は私の最初のアプローチですが、これが正しい方法なのでしょうか? 

class DocumentStatus{

    public enum StatusFlag {

        DOCUMENT_STATUS_NOT_DEFINED(1<<0),
        DOCUMENT_STATUS_OK(1<<1), 
        DOCUMENT_STATUS_MISSING_TID_DIR(1<<2),
        DOCUMENT_STATUS_MISSING_TIF_FILE(1<<3),
        DOCUMENT_STATUS_MISSING_PDF_FILE(1<<4),
        DOCUMENT_STATUS_MISSING_OCR_FILE(1<<5),
        DOCUMENT_STATUS_PAGE_COUNT_TIF(1<<6),
        DOCUMENT_STATUS_PAGE_COUNT_PDF(1<<7),
        DOCUMENT_STATUS_UNAVAILABLE(1<<8);


        private final long statusFlagValue;

        StatusFlag(long statusFlagValue) {
            this.statusFlagValue = statusFlagValue;
        }

        public long getStatusFlagValue(){
            return statusFlagValue;
        } 

       }


    /**
     * Translates a numeric status code into a Set of StatusFlag enums
     * @param numeric statusValue 
     * @return EnumSet representing a documents status
     */
    public EnumSet<StatusFlag> getStatusFlags(long statusValue) {
        EnumSet statusFlags = EnumSet.noneOf(StatusFlag.class);
        StatusFlag.each { statusFlag -> 
            long flagValue = statusFlag.statusFlagValue
            if ( (flagValue&statusValue ) == flagValue ) {
               statusFlags.add(statusFlag);
            }
        }
        return statusFlags;
    }


    /**
     * Translates a set of StatusFlag enums into a numeric status code
     * @param Set if statusFlags
     * @return numeric representation of the document status 
     */
    public long getStatusValue(Set<StatusFlag> flags) {
        long value=0;
        flags.each { statusFlag -> 
            value|=statusFlag.getStatusFlagValue() 
        }
        return value;
    }

     public static void main(String[] args) {

        DocumentStatus ds = new DocumentStatus();
        Set statusFlags = EnumSet.of(
            StatusFlag.DOCUMENT_STATUS_OK,
            StatusFlag.DOCUMENT_STATUS_UNAVAILABLE);

        assert ds.getStatusValue( statusFlags )==258 // 0000.0001|0000.0010

        long numericStatusCode = 56;
        statusFlags = ds.getStatusFlags(numericStatusCode);

        assert !statusFlags.contains(StatusFlag.DOCUMENT_STATUS_OK);
        assert statusFlags.contains(StatusFlag.DOCUMENT_STATUS_MISSING_TIF_FILE);
        assert statusFlags.contains(StatusFlag.DOCUMENT_STATUS_MISSING_PDF_FILE);
        assert statusFlags.contains(StatusFlag.DOCUMENT_STATUS_MISSING_OCR_FILE);

    }

}
役に立ちましたか？

解決

あなたのアプローチはまさにそれを行う方法です。

他のヒント

コンストラクターパラメーターを定義する代わりに、内部を使用するだけで使用できます ordinal() これを計算する価値。

public enum StatusFlag {

    DOCUMENT_STATUS_NOT_DEFINED,
    DOCUMENT_STATUS_OK, 
    DOCUMENT_STATUS_MISSING_TID_DIR,
    DOCUMENT_STATUS_MISSING_TIF_FILE,
    DOCUMENT_STATUS_MISSING_PDF_FILE,
    DOCUMENT_STATUS_MISSING_OCR_FILE,
    DOCUMENT_STATUS_PAGE_COUNT_TIF,
    DOCUMENT_STATUS_PAGE_COUNT_PDF,
    DOCUMENT_STATUS_UNAVAILABLE;


    public long getStatusFlagValue(){
        return 1 << this.ordinal();
    } 

}

これで、並べ替え、挿入（最後以外）、またはエントリの削除を控える必要があることに注意してください。そうしないと、フラグ値が変更され、データベースの内容の意味が変更されます。

わずかに良い方法は、の結果を保存することです 1 << this.ordinal() 列挙値が構築されたフィールドで。これにより、各値を手動で提供する必要はなく、フラグは1回だけ計算されます。

public enum StatusFlag {

  DOCUMENT_STATUS_NOT_DEFINED,
  DOCUMENT_STATUS_OK, 
  DOCUMENT_STATUS_MISSING_TID_DIR,
  DOCUMENT_STATUS_MISSING_TIF_FILE,
  DOCUMENT_STATUS_MISSING_PDF_FILE,
  DOCUMENT_STATUS_MISSING_OCR_FILE,
  DOCUMENT_STATUS_PAGE_COUNT_TIF,
  DOCUMENT_STATUS_PAGE_COUNT_PDF,
  DOCUMENT_STATUS_UNAVAILABLE;

  public final int flag;

  StatusFlag() { 
    this.flag = 1 << this.ordinal();
  } 
}

編集：ISFLAGSETメソッドも持っていると便利です。

enum 値を指定しないでください。を使用してください EnumSet それらを組み合わせて使用​​します Enum.ordinal() 単一の整数との間で変換するために永続化する場合。あなたも見つけるかもしれません Class.getEnumConstants() 整数からセットを再構築する場合に便利です。

私はこの問題のために完全なライブラリを作成しました：http://claude-martin.ch/enumbitset/

主な目標は、ビットフィールドに列挙タイプのセットを保存することでした。しかし、それは他のタイプもサポートしています。

これにより、「getStatusFlags（）」のような追加の方法は必要ありません。インターフェイスを追加するだけで、既存の列挙タイプで使用できます Enumbitsethelper （「特性」のように使用されます）。次に、各列挙定数は、Javaの列挙とビットセットのすべての方法を持つ「Enumbiteset」を作成できます。次に、これらの列挙定数のセットを使用して、ビットフィールド値に変換できます。

BigintegerやLongなどの多くの形式をサポートして、値を少しフィールドに簡単に保存します。ただし、これはJavaバージョン8以下でのみ機能することに注意してください。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top