/*
 * このソースコードは blanco Frameworkにより自動生成されました。
 */
package blanco.logmessage.valueobject;

import java.util.List;

/**
 * BlancoLogMessageのなかで利用されるValueObjectです。
 */
public class BlancoLogMessageStructure {
    /**
     * ログメッセージ定義IDを指定します。必須項目です。
     *
     * フィールド: [name]。
     */
    private String fName;

    /**
     * パッケージ名を指定します。必須項目です。
     *
     * フィールド: [package]。
     */
    private String fPackage;

    /**
     * メッセージ定義の説明を記載します。
     *
     * フィールド: [description]。
     */
    private String fDescription;

    /**
     * クラス名の後方に付与されるサフィックス。
     *
     * フィールド: [suffix]。
     */
    private String fSuffix;

    /**
     * メッセージ文字列にID埋め込みを行うかどうか。
     *
     * フィールド: [idEmbedding]。
     * デフォルト: [false]。
     */
    private boolean fIdEmbedding = false;

    /**
     * 標準出力を生成するかどうか。
     *
     * フィールド: [stdout]。
     * デフォルト: [false]。
     */
    private boolean fStdout = false;

    /**
     * フィールドを保持するリスト。
     *
     * フィールド: [fieldList]。
     * デフォルト: [new java.util.ArrayList<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure>()]。
     */
    private List<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure> fFieldList = new java.util.ArrayList<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure>();

    /**
     * フィールド [name] の値を設定します。
     *
     * フィールドの説明: [ログメッセージ定義IDを指定します。必須項目です。]。
     *
     * @param argName フィールド[name]に設定する値。
     */
    public void setName(final String argName) {
        fName = argName;
    }

    /**
     * フィールド [name] の値を取得します。
     *
     * フィールドの説明: [ログメッセージ定義IDを指定します。必須項目です。]。
     *
     * @return フィールド[name]から取得した値。
     */
    public String getName() {
        return fName;
    }

    /**
     * フィールド [package] の値を設定します。
     *
     * フィールドの説明: [パッケージ名を指定します。必須項目です。]。
     *
     * @param argPackage フィールド[package]に設定する値。
     */
    public void setPackage(final String argPackage) {
        fPackage = argPackage;
    }

    /**
     * フィールド [package] の値を取得します。
     *
     * フィールドの説明: [パッケージ名を指定します。必須項目です。]。
     *
     * @return フィールド[package]から取得した値。
     */
    public String getPackage() {
        return fPackage;
    }

    /**
     * フィールド [description] の値を設定します。
     *
     * フィールドの説明: [メッセージ定義の説明を記載します。]。
     *
     * @param argDescription フィールド[description]に設定する値。
     */
    public void setDescription(final String argDescription) {
        fDescription = argDescription;
    }

    /**
     * フィールド [description] の値を取得します。
     *
     * フィールドの説明: [メッセージ定義の説明を記載します。]。
     *
     * @return フィールド[description]から取得した値。
     */
    public String getDescription() {
        return fDescription;
    }

    /**
     * フィールド [suffix] の値を設定します。
     *
     * フィールドの説明: [クラス名の後方に付与されるサフィックス。]。
     *
     * @param argSuffix フィールド[suffix]に設定する値。
     */
    public void setSuffix(final String argSuffix) {
        fSuffix = argSuffix;
    }

    /**
     * フィールド [suffix] の値を取得します。
     *
     * フィールドの説明: [クラス名の後方に付与されるサフィックス。]。
     *
     * @return フィールド[suffix]から取得した値。
     */
    public String getSuffix() {
        return fSuffix;
    }

    /**
     * フィールド [idEmbedding] の値を設定します。
     *
     * フィールドの説明: [メッセージ文字列にID埋め込みを行うかどうか。]。
     *
     * @param argIdEmbedding フィールド[idEmbedding]に設定する値。
     */
    public void setIdEmbedding(final boolean argIdEmbedding) {
        fIdEmbedding = argIdEmbedding;
    }

    /**
     * フィールド [idEmbedding] の値を取得します。
     *
     * フィールドの説明: [メッセージ文字列にID埋め込みを行うかどうか。]。
     * デフォルト: [false]。
     *
     * @return フィールド[idEmbedding]から取得した値。
     */
    public boolean getIdEmbedding() {
        return fIdEmbedding;
    }

    /**
     * フィールド [stdout] の値を設定します。
     *
     * フィールドの説明: [標準出力を生成するかどうか。]。
     *
     * @param argStdout フィールド[stdout]に設定する値。
     */
    public void setStdout(final boolean argStdout) {
        fStdout = argStdout;
    }

    /**
     * フィールド [stdout] の値を取得します。
     *
     * フィールドの説明: [標準出力を生成するかどうか。]。
     * デフォルト: [false]。
     *
     * @return フィールド[stdout]から取得した値。
     */
    public boolean getStdout() {
        return fStdout;
    }

    /**
     * フィールド [fieldList] の値を設定します。
     *
     * フィールドの説明: [フィールドを保持するリスト。]。
     *
     * @param argFieldList フィールド[fieldList]に設定する値。
     */
    public void setFieldList(final List<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure> argFieldList) {
        fFieldList = argFieldList;
    }

    /**
     * フィールド [fieldList] の値を取得します。
     *
     * フィールドの説明: [フィールドを保持するリスト。]。
     * デフォルト: [new java.util.ArrayList<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure>()]。
     *
     * @return フィールド[fieldList]から取得した値。
     */
    public List<blanco.logmessage.valueobject.BlancoLogMessageFieldStructure> getFieldList() {
        return fFieldList;
    }

    /**
     * このバリューオブジェクトの文字列表現を取得します。
     *
     * <P>使用上の注意</P>
     * <UL>
     * <LI>オブジェクトのシャロー範囲のみ文字列化の処理対象となります。
     * <LI>オブジェクトが循環参照している場合には、このメソッドは使わないでください。
     * </UL>
     *
     * @return バリューオブジェクトの文字列表現。
     */
    @Override
    public String toString() {
        final StringBuffer buf = new StringBuffer();
        buf.append("blanco.logmessage.valueobject.BlancoLogMessageStructure[");
        buf.append("name=" + fName);
        buf.append(",package=" + fPackage);
        buf.append(",description=" + fDescription);
        buf.append(",suffix=" + fSuffix);
        buf.append(",idEmbedding=" + fIdEmbedding);
        buf.append(",stdout=" + fStdout);
        buf.append(",fieldList=" + fFieldList);
        buf.append("]");
        return buf.toString();
    }
}
