47.6. 除外された引数

概要

Java 引数を URI オプションにマッピングする際、特定の引数を除外する必要がある場合があります。camel-api-component-maven-plugin プラグイン設定で excludeConfigNames 要素または excludeConfigTypes 要素を指定して、不要な引数をフィルタリングすることができます。

構文

excludeConfigNames 要素と excludeConfigTypes 要素は以下のように指定されます。

<excludeConfigNames>ArgumentNamePattern</excludeConfigNames>
<excludeConfigTypes>TypeNamePattern</excludeConfigTypes>

ここでの ArgumentNamePatternTypeNamePattern は、それぞれ引数名と引数型に一致する正規表現です。

スコープ

以下の抜粋で示されているように、excludeConfigNames 要素と excludeConfigTypes 要素は、任意で apis 要素や api 要素の子とすることができます。

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <excludeConfigNames>...</excludeConfigNames>
      <excludeConfigTypes>...</excludeConfigTypes>
    </api>
    <excludeConfigNames>...</excludeConfigNames>
    <excludeConfigTypes>...</excludeConfigTypes>
    ...
  </apis>
</configuration>

以下のスコープで excludeConfigNames 要素および excludeConfigTypes 要素を定義できます。

  • api 要素の子として: 除外は api 要素で指定された API クラスにのみ適用されます。
  • apis 要素の子として: 除外はデフォルトですべての API クラスに適用されますが、api レベルで上書きできます。

要素

以下の要素を使用して、(URI オプションとして利用できないように引数を API マッピングから除外することができます。

excludeConfigNames
引数名の一致に基づいて、引数を除外するための正規表現 (java.util.regex 構文) を指定します。
excludeConfigTypes
引数型の一致に基づいて、引数を除外するための正規表現 (java.util.regex 構文) を指定します。