com.asakusafw.vocabulary.operator

Annotation Type Logging

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Logging

ロギング演算子を表すメソッドに付与する注釈。

この演算子は、入力されたデータをそのまま出力するが、その際にロギングを行う。

一つのモデルオブジェクト型の引数を取り、ロガーに出力するログ文字列を返す。 なお、引数のオブジェクトの内容を変更してはならない。

また、この注釈の要素にLogging.Levelの値を指定することで、 出力するログのレベルを変更できる (標準では「情報レベル」)。 この演算子を結線する場合、出力outは他の演算子等と結線されていなくても エラーにならないという特性を持つ。

また、引数には同メソッドで宣言した型変数を利用できる。 例えば上限境界の無い型引数を定義して、引数の型として利用すると、 すべてのデータを受け取れるようなロギング演算子を定義できる。

この注釈を付与するメソッドは、一般的な演算子メソッドの要件の他に、 下記の要件をすべて満たす必要がある。

• 返戻型にStringを指定する
• 以下の引数を宣言する
  • モデルオブジェクト型の引数
• 以下の修飾子を付与する
  • (特になし)
• 以下の修飾子は付与しない
  • abstract

例:

/**
 * エラーログを出力する。
 * @param hoge 更新するレコード
 */
@Logging(Logging.Level.ERROR)
public String error(Hoge hoge) {
    return MessageFormat.format("hoge = {0}", hoge.getValueOption());
}

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ID_INPUT The input port number.
static int	ID_OUTPUT The output port number.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	outputPort The default output port name.
Logging.Level	value ログのレベル。

Field Detail

ID_INPUT

public static final int ID_INPUT

The input port number.

ID_OUTPUT

public static final int ID_OUTPUT

The output port number.

Element Detail

outputPort

public abstract String outputPort

The default output port name.

Default:

"out"

value

public abstract Logging.Level value

ログのレベル。

Default:

com.asakusafw.vocabulary.operator.Logging.Level.INFO