モジュール java.xml.ws
パッケージ javax.xml.soap

インタフェースName



  • public interface Name
    XML名の表現です。 このインタフェースは、ローカル名と名前空間修飾名を取得するメソッドや、名前の名前空間に関連付けられた接頭辞を取得するメソッドを提供します。 また、名前空間のURIを取得することも可能です。

    以下は、要素内のネームスペース宣言の例です。<wombat:GetLastTradePrice xmlns:wombat="http://www.wombat.org/trader"> ("xmlns"は"XMLネームスペース"の略です。) Nameインタフェースのメソッドが返すものは次のとおりです。

    • getQualifiedNameは"prefix:LocalName" = "WOMBAT:GetLastTradePrice"を返す
    • getURIは"http://www.wombat.org/trader"を返す
    • getLocalNameは"GetLastTracePrice"を返す
    • getPrefixは"WOMBAT"を返す

    XMLの名前空間を使用すると、アプリケーション固有の識別子から発生するSOAP識別子間の差異をなくすことができます。

    Nameオブジェクトは、2つのバージョンのSOAPEnvelope.createNameメソッドにより作成されます。 1つはローカル名、名前空間の接頭辞、名前空間のURIを使用してNameオブジェクトを作成し、もう1つは、ローカル名のみを使用してNameオブジェクトを作成するメソッドです。 次のコード行(seSOAPEnvelopeオブジェクト)では、3つすべてを使用して新しいNameオブジェクトを作成します。

    
         Name name = se.createName("GetLastTradePrice", "WOMBAT",
                                    "http://www.wombat.org/trader");
     
    次のコードで、Nameオブジェクトの使用例を示します。 変数elementSOAPElementオブジェクトを意味します。 この例では、指定の名前でSOAPElementオブジェクトを新しく作成し、elementにそれを追加しています。
    
         element.addChildElement(name);
     

    Nameインタフェースは、javax.xml.namespace.QNameとの関係で、SAAJの将来のリリースで非推奨になる可能性があります。

    導入されたバージョン:
    1.6
    関連項目:
    SOAPEnvelope.createName, SOAPFactory.createName
    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 
      修飾子と型 メソッド 説明
      String getLocalName​()
      このNameオブジェクトが表すXML名のローカル名の部分を取得します。
      String getPrefix​()
      このNameオブジェクトが初期化された際に、指定された接頭辞を返します。
      String getQualifiedName​()
      このNameオブジェクトが表すXML名の名前空間修飾名を取得します。
      String getURI​()
      このNameオブジェクトが表すXML名の名前空間のURIを返します。
    • メソッドの詳細

      • getLocalName

        String getLocalName​()
        このNameオブジェクトが表すXML名のローカル名の部分を取得します。
        戻り値:
        ローカル名を提供する文字列
      • getQualifiedName

        String getQualifiedName​()
        このNameオブジェクトが表すXML名の名前空間修飾名を取得します。
        戻り値:
        文字列の名前空間修飾名
      • getPrefix

        String getPrefix​()
        このNameオブジェクトが初期化された際に、指定された接頭辞を返します。 この接頭辞はNameオブジェクトが表すXML名の名前空間に関連付けられています。
        戻り値:
        文字列の接頭辞
      • getURI

        String getURI​()
        このNameオブジェクトが表すXML名の名前空間のURIを返します。
        戻り値:
        文字列のURI