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 オブジェクトを作成するメソッドです。次のコード行 (se は SOAPEnvelope オブジェクト) では、3 つすべてを使用して新しい Name オブジェクトを作成します。

     Name name = se.createName("GetLastTradePrice", "WOMBAT",
                                "http://www.wombat.org/trader");
 

次のコードで、Name オブジェクトの使用例を示します。変数 element は SOAPElement オブジェクトを意味します。この例では、指定の名前で SOAPElement オブジェクトを新しく作成し、element にそれを追加しています。

     element.addChildElement(name);
 

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

関連項目:

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