LauncherLogFormatter (NablarchApi)

java.lang.Object
- nablarch.fw.launcher.logging.LauncherLogFormatter

```
@Published(tag="architect")
public class LauncherLogFormatter
extends Object
```
Mainで出力するログメッセージをフォーマットするクラス。

作成者:

hisaaki sioiri

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String PROPS_PREFIX
プロパティ名のプレフィックス

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`PROPS_PREFIX` プロパティ名のプレフィックス

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected String`	`getEndLogFormat()` 終了ログのフォーマットを取得する。
`protected Map<LogItem>`	`getEndLogItems()` 終了ログ用のログ出力項目を生成する。
`String`	`getEndLogMsg(int exitCode, long executeTime)` 終了ログを生成する。
`protected String`	`getStartLogFormat()` 開始ログのフォーマットを取得する。
`protected Map<LogItem>`	`getStartLogItems()` 開始ログ用のログ出力項目を生成する。
`String`	`getStartLogMsg(CommandLine commandLine)` 開始ログを生成する。

- フィールドの詳細
  - PROPS_PREFIX
```
public static final String PROPS_PREFIX
```
    プロパティ名のプレフィックス
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - getStartLogMsg
```
public String getStartLogMsg(CommandLine commandLine)
```
    開始ログを生成する。
    LauncherLogFormatter.getStartLogFormat()から取得したログフォーマットに従いログメッセージ生成を行う。
    
    パラメータ:
    
    commandLine - コマンドラインオブジェクト
    
    戻り値:
    
    生成した開始ログ
  - getEndLogMsg
```
public String getEndLogMsg(int exitCode,
                           long executeTime)
```
    終了ログを生成する。
    LauncherLogFormatter.getEndLogFormat()から取得したログフォーマットに従いログメッセージの生成を行う。
    
    パラメータ:
    
    exitCode - 終了コード
    
    executeTime - 処理時間
    
    戻り値:
    
    生成した終了ログ
  - getStartLogFormat
```
protected String getStartLogFormat()
```
    開始ログのフォーマットを取得する。
    設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、そのフォーマットを返却する。設定されていない場合には、デフォルトのフォーマットを使用する。
    デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能
```
 
 launcherLogFormatter.startFormat = @@@@ BEGIN @@@@\n\tcommandLineArguments = [$commandLineArguments$]
 
 
```
    戻り値:
    
    開始ログのフォーマット
  - getStartLogItems
```
protected Map<LogItem> getStartLogItems()
```
    開始ログ用のログ出力項目を生成する。
    
    戻り値:
    
    生成したログ出力項目
  - getEndLogItems
```
protected Map<LogItem> getEndLogItems()
```
    終了ログ用のログ出力項目を生成する。
    
    戻り値:
    
    生成したログ出力項目
  - getEndLogFormat
```
protected String getEndLogFormat()
```
    終了ログのフォーマットを取得する。
    設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、そのフォーマットを返却する。設定されていない場合には、デフォルトのフォーマットを使用する。
    デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能
```
 
 launcherLogFormatter.endFormat = @@@@ END @@@@ execute time(ms) = [$executeTime$], exit code = [$exitCode$]
 
 
```
    戻り値:
    
    開始ログのフォーマット

クラス LauncherLogFormatter

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

PROPS_PREFIX

メソッドの詳細

getStartLogMsg

getEndLogMsg

getStartLogFormat

getStartLogItems

getEndLogItems

getEndLogFormat