EventFamily.java

/*
 * family of system-event-message
 *
 * License : The MIT License
 * Copyright(c) 2009 olyutorskii
 */

package jp.sourceforge.jindolf.corelib;

/**
 * システムイベントメッセージのおおまかな種別。
 */
public enum EventFamily{

    /** <div class="announce">メッセージに対応。 */
    ANNOUNCE("announce"),
    /** <div class="order">メッセージに対応。 */
    ORDER("order"),
    /** <div class="extra">メッセージに対応。 */
    EXTRA("extra"),
    ;

    private final String divClass;

    /**
     * コンストラクタ。
     * @param divClass divタグclass名
     */
    EventFamily(String divClass){
        this.divClass = divClass;
        return;
    }

    /**
     * 由来となった<div>要素のclass属性値を得る。
     * @return class属性値
     */
    public String getDivClass(){
        return this.divClass;
    }

    /**
     * XML用シンボルを取得する。
     * @return XML用シンボル
     */
    public String getXmlName(){
        return this.divClass;
    }

}