web-dev-qa-db-ja.com

Java enumsを使用してビットフィールドを実装する

私は大きなドキュメントアーカイブを保持しており、ビットフィールドを使用して、処理中または検証中にドキュメントのステータスを記録することがよくあります。私のレガシーコードは、次のような静的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;

静的定数を使用するアプローチは悪い習慣であり、コードを改善したいので、Enumsを使用して同じことを実現しようとしていました。いくつかの要件がありますが、その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);

    }

}
javaenumsenumset
37
soappatrol

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

14
Ray Tayek

コンストラクターのパラメーターを定義する代わりに、内部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();
    } 

}

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

33
Paŭlo Ebermann

少し良い方法は、列挙値が構築されるときに、1 << this.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 final int flag;

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

編集：isFlagSetメソッドもあると便利です。

8
ChrisBlom

列挙値を与えないでください。 EnumSetを使用してそれらを結合し、永続化するときにEnum.ordinal()を使用して単一の整数との間で変換します。また、整数からセットを再構築するときにClass.getEnumConstants()が役立つかもしれません。

6
OrangeDog

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

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

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

BigIntegerやlongなどの多くの形式をサポートしており、ビットフィールドに値を簡単に格納できます。ただし、これはJavaバージョン8以降でのみ機能することに注意してください。

4
Claude Martin