CommandLine (Nablarch-API)

java.lang.Object
- nablarch.fw.launcher.CommandLine

すべての実装されたインタフェース:

Request<java.lang.String>
```
@Published(tag="architect")
public class CommandLine
extends java.lang.Object
implements Request<java.lang.String>
```
コマンドラインオプション、コマンドライン引数をパースして格納するクラス。
コマンドラインオプション
オプションの書式は以下となる。 ※「-(ハイフン)」は一つまたは二つ付与する。どちらでも処理に影響しない。
- -オプション名値 (例：java -requestPath test.SampleAction/BC001)
- --オプション名値 (例：java --requestPath test.SampleAction/BC001)
- -オプション名 (例：java -server)
- --オプション名 (例：java --server)
コマンドライン引数
引数の書式は以下となる。
- 値 (例：java someValue)
必須のオプションが含まれていない場合はBadRequestを送出する。必須のオプションについてはMainのJavaDocを参照。
関連項目:

Main

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`CommandLine(java.util.Map<java.lang.String,java.lang.String> opts, java.util.List<java.lang.String> args)` テスト用に使用するコンストラクタ。
`CommandLine(java.lang.String... commandline)` デフォルトコンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.util.List<java.lang.String>`	`getArgs()` コマンドライン引数のリストを返す。
`java.lang.String`	`getParam(java.lang.String name)` リクエストパラメータを取得する。
`java.util.Map<java.lang.String,java.lang.String>`	`getParamMap()` リクエストパラメータのMapを取得する。
`java.lang.String`	`getRequestPath()` リクエストパスを取得する。
`CommandLine`	`setParamMap(java.util.Map<java.lang.String,java.lang.String> opts)` コマンドラインオプションのMapを設定する。
`CommandLine`	`setRequestPath(java.lang.String requestPath)` リクエストパスを設定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - CommandLine
```
public CommandLine(java.lang.String... commandline)
```
    デフォルトコンストラクタ
    
    パラメータ:
    
    commandline - コマンドライン文字列
  - CommandLine
```
public CommandLine(java.util.Map<java.lang.String,java.lang.String> opts,
                   java.util.List<java.lang.String> args)
```
    テスト用に使用するコンストラクタ。
    
    パラメータ:
    
    opts - コマンドラインオプションのMap
    
    args - コマンドラインオプションのList
- メソッドの詳細
  - getRequestPath
```
public java.lang.String getRequestPath()
```
    リクエストパスを取得する。
    リクエストパスを返す。デフォルトでは実行されたコマンドのフルパス文字列を返す。
    
    定義:
    
    getRequestPath インタフェース内 Request<java.lang.String>
    
    戻り値:
    
    リクエストパス
  - setRequestPath
```
public CommandLine setRequestPath(java.lang.String requestPath)
```
    リクエストパスを設定する。
    
    定義:
    
    setRequestPath インタフェース内 Request<java.lang.String>
    
    パラメータ:
    
    requestPath - リクエストパス
    
    戻り値:
    
    オブジェクト自体
  - getParam
```
@Published
public java.lang.String getParam(java.lang.String name)
```
    リクエストパラメータを取得する。
    コマンドラインオプションの値を返す。値が指定されていない場合は空文字を返す。
```
 例
 -requestPath test.SampleAction/BC001 --> "test.SampleAction/BC001"を返す。
 -server --> ""を返す。
 
```
    定義:
    
    getParam インタフェース内 Request<java.lang.String>
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    パラメータの値
    
    関連項目:
    
    Request.getParamMap()
  - getParamMap
```
@Published
public java.util.Map<java.lang.String,java.lang.String> getParamMap()
```
    リクエストパラメータのMapを取得する。
    コマンドラインオプションのMapを取得する。
    
    定義:
    
    getParamMap インタフェース内 Request<java.lang.String>
    
    戻り値:
    
    リクエストパラメータのMap
  - setParamMap
```
public CommandLine setParamMap(java.util.Map<java.lang.String,java.lang.String> opts)
```
    コマンドラインオプションのMapを設定する。
    
    パラメータ:
    
    opts - 名前付きコマンドライン引数のMap
    
    戻り値:
    
    このオブジェクト自体
  - getArgs
```
@Published
public java.util.List<java.lang.String> getArgs()
```
    コマンドライン引数のリストを返す。
    
    戻り値:
    
    引数リスト

クラス CommandLine

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

CommandLine

CommandLine

メソッドの詳細

getRequestPath

setRequestPath

getParam

getParamMap

setParamMap

getArgs