ModuleDescriptor (Spring XD 1.3.2.RELEASE API)

java.lang.Object
- org.springframework.xd.module.ModuleDescriptor

実装されているすべてのインターフェース:
java.lang.Comparable<ModuleDescriptor>
```
public class ModuleDescriptor
extends java.lang.Object
implements java.lang.Comparable<ModuleDescriptor>
```
定義されたストリームまたはジョブのコンテキストにおけるモジュールの表現。
作成者:
Mark Fisher, Gary Russell, Luke Taylor, Ilayaperumal Gopinathan, Patrick Peralta

ネストされたクラスの要約

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`ModuleDescriptor.Builder` `ModuleDescriptor` のビルダーオブジェクト。
`static class`	`ModuleDescriptor.Key` ModuleDescriptors のマップで使用するキー。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`int`	`compareTo(ModuleDescriptor o)`
`ModuleDescriptor.Key`	`createKey()` この `ModuleDescriptor` に新しい `ModuleDescriptor.Key` を作成します。
`java.util.List<ModuleDescriptor>`	`getChildren()` これが複合モジュールの場合、このリストにはこのモジュールを構成するモジュールが含まれます。それ以外の場合は、このリストは空になります。
`java.lang.String`	`getGroup()` このモジュールインスタンスが属するデプロイ可能なユニットの名前 (ストリームやジョブなど) を返します。
`int`	`getIndex()` 定義内の他のモジュールに対するストリーム / ジョブ定義内の位置を返します。
`ModuleDefinition`	`getModuleDefinition()` このモジュールの `ModuleDefinition` を返します。
`java.lang.String`	`getModuleLabel()` モジュールのシンボリック名を返します。
`java.lang.String`	`getModuleName()` モジュールの名前を返します。
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()` モジュールのパラメーターを返します。
`java.lang.String`	`getSinkChannelName()` ストリーム / ジョブ定義で定義されている場合、シンクチャネルの名前を返します。
`java.lang.String`	`getSourceChannelName()` ストリーム / ジョブ定義で定義されている場合、ソースチャネルの名前を返します。
`ModuleType`	`getType()` モジュール型を返します。
`boolean`	`isComposed()` これが合成モジュールである場合は true を返します。
`java.lang.String`	`toString()`

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

- メソッドの詳細
  - getModuleName
```
public java.lang.String getModuleName()
```
    モジュールの名前を返します。通常、このモジュールは $XD_HOME/modules/[module type] に存在します。
    戻り値:
    モジュール名
  - getModuleLabel
```
public java.lang.String getModuleLabel()
```
    モジュールのシンボリック名を返します。これは DSL 文字列で明示的に指定できます。これは、ストリームに同じ名前の別のモジュールが含まれている場合に必要です。それ以外の場合は、モジュール名と同じになります。
    戻り値:
    モジュールラベル
  - getGroup
```
public java.lang.String getGroup()
```
    このモジュールインスタンスが属するデプロイ可能なユニットの名前 (ストリームやジョブなど) を返します。
    戻り値:
    グループ名
  - getIndex
```
public int getIndex()
```
    定義内の他のモジュールに対するストリーム / ジョブ定義内の位置を返します。0 は最初 / 左端の位置を示します。
    戻り値:
    モジュールインデックス
  - getType
```
public ModuleType getType()
```
    モジュール型を返します。
    戻り値:
    モジュールタイプの選択
  - getSourceChannelName
```
public java.lang.String getSourceChannelName()
```
    ストリーム / ジョブ定義で定義されている場合、ソースチャネルの名前を返します。null の場合もあります。
    戻り値:
    ソースチャネル名、またはソースチャネルが定義されていない場合は null
  - getSinkChannelName
```
public java.lang.String getSinkChannelName()
```
    ストリーム / ジョブ定義で定義されている場合、シンクチャネルの名前を返します。null の場合もあります。
    戻り値:
    シンクチャネル名、またはシンクチャネルが定義されていない場合は null
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    モジュールのパラメーターを返します。これはモジュールの種類に固有です。たとえば、http モジュールにはパラメーターとしてポート番号が含まれます。
    戻り値:
    モジュールパラメーターの読み取り専用マップ
  - getChildren
```
public java.util.List<ModuleDescriptor> getChildren()
```
    これが複合モジュールの場合、このリストにはこのモジュールを構成するモジュールが含まれます。それ以外の場合は、このリストは空になります。
    戻り値:
    このモジュールのサブモジュール、または複合モジュールでない場合は空のリスト
  - getModuleDefinition
```
public ModuleDefinition getModuleDefinition()
```
    このモジュールの ModuleDefinition を返します。ModuleDefinition には、モジュールをロードするために必要な情報 (クラスパスなど) が含まれています。
    戻り値:
    このモジュール記述子のモジュール定義
  - isComposed
```
public boolean isComposed()
```
    これが合成モジュールである場合は true を返します。合成モジュールは 1 つ以上の子モジュールで構成されます。
    戻り値:
    これが複合モジュールである場合は true
    関連事項:
    children
  - createKey
```
public ModuleDescriptor.Key createKey()
```
    この ModuleDescriptor に新しい ModuleDescriptor.Key を作成します。
    戻り値:
    新しい Key
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString
  - compareTo
```
public int compareTo(ModuleDescriptor o)
```
    次で指定:
    インターフェース java.lang.Comparable<ModuleDescriptor> の compareTo

クラス ModuleDescriptor

ネストされたクラスの要約

メソッドのサマリー

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

メソッドの詳細

getModuleName

getModuleLabel

getGroup

getIndex

getType

getSourceChannelName

getSinkChannelName

getParameters

getChildren

getModuleDefinition

isComposed

createKey

toString

compareTo