6.9.17 XBRLQNameクラス

public final class XBRLQName
extends java.lang.Object

XBRLのバージョン:
2.0および2.1
説明:
XML Schemaのデータ型QNameを表します。QName型は,Namespaces in XMLで定義されている修飾名(Qualified Name)を表します。修飾名は,名前空間接頭辞とローカルパートから構成されますが,XBRLQNameクラスでは,名前空間接頭辞を保持しません。代わりに,名前空間接頭辞に関連づけられる名前空間URIを保持します。
コンストラクタの概要:
XBRLQNameクラスのコンストラクタの概要を次の表に示します。

表6-154 XBRLQNameクラスのコンストラクタの概要

項番説明XBRLのバージョン
1XBRLQName(java.lang.String qname)
  指定したQNameの文字列表現からXBRLQNameオブジェクトを構築します。
2.0および2.1
2XBRLQName(java.lang.String namespaceURI, java.lang.String localPart)
  指定した名前空間URIおよびローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを構築します。
2.0および2.1
3XBRLQName(java.lang.String qname, boolean validate)
  指定したQNameの文字列表現からXBRLQNameオブジェクトを構築します。
2.0および2.1
4XBRLQName(java.lang.String namespaceURI, java.lang.String localPart, boolean validate)
  指定した名前空間URIおよびローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを構築します。
2.0および2.1
メソッドの概要:
XBRLQNameクラスのメソッドの概要を次の表に示します。

表6-155 XBRLQNameクラスのメソッドの概要

項番説明XBRLのバージョン
1java.lang.StringgetNamespaceURI()
  QNameの名前空間URIを取得します。
2.0および2.1
2java.lang.StringgetLocalPart()
  QNameのローカルパートを取得します。
2.0および2.1
3java.lang.StringtoString()
  QNameの文字列表現を取得します。
2.0および2.1
4static java.lang.StringtoString(java.lang.String namespaceURI, java.lang.String localPart)
  指定した名前空間URIおよびローカルパートで構成される,QNameの文字列表現を取得します。
2.0および2.1
5static XBRLQNamevalueOf(java.lang.String qname)
  指定したQNameの文字列表現からXBRLQNameオブジェクトを取得します。
2.0および2.1
6static XBRLQNamevalueOf(java.lang.String namespaceURI, java.lang.String localPart)
  指定した名前空間URIとローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを取得します。
2.0および2.1
7booleanequals(java.lang.Object obj)
  XBRLQNameオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
2.0および2.1
8inthashCode()
  XBRLQNameオブジェクトのハッシュコードを取得します。
2.0および2.1
<この項の構成>
(1) XBRLQName
(2) XBRLQName
(3) XBRLQName
(4) XBRLQName
(5) getNamespaceURI
(6) getLocalPart
(7) toString
(8) toString
(9) valueOf
(10) valueOf
(11) equals
(12) hashCode

(1) XBRLQName

public  XBRLQName(java.lang.String qname)

XBRLのバージョン:
2.0および2.1
説明:
指定したQNameの文字列表現からXBRLQNameオブジェクトを構築します。
QNameの文字列表現は,"{namespaceURI}localPart"です。"{namespaceURI}"の部分は省略できます。
このコンストラクタでは,引数qnameで指定したQNameの文字列表現に不正な文字が含まれるかどうかはチェックしません。
引数:
qname - QNameの文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数qnameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数qnameに指定したQNameの文字列表現が不正なフォーマットの場合にスローされます。[エラーコード:25000]

(2) XBRLQName

public  XBRLQName(java.lang.String namespaceURI,
                 java.lang.String localPart)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間URIおよびローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを構築します。
このコンストラクタでは,引数namespaceURIおよびlocalPartで指定した文字列に,不正な文字が含まれるかどうかはチェックしません。
引数:
namespaceURI - QNameの名前空間URIを指定します。名前空間URIがない場合は,nullを指定します。
localPart - QNameのローカルパートを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数localPartにnullまたは空文字列("")を指定した場合にスローされます。[エラーコード:20002,25000]

(3) XBRLQName

public  XBRLQName(java.lang.String qname,
                 boolean validate)

XBRLのバージョン:
2.0および2.1
説明:
指定したQNameの文字列表現からXBRLQNameオブジェクトを構築します。QNameの文字列表現は"{namespaceURI}localPart"です。"{namespaceURI}"の部分は省略できます。
引数validateにtrueを指定した場合だけ,QNameの文字列表現に不正な文字が含まれるかどうかをチェックします。その場合,namespaceURIおよびlocalPartには,それぞれXML Schemaのデータ型anyURIおよびNCNameとして妥当な文字列だけを指定できます。ただしnamespaceURIに空文字列("")は指定できません。
引数:
qname - QNameの文字列表現を指定します。
validate - QNameの文字列表現に不正な文字が含まれているかどうかをチェックする場合は,trueを指定します。チェックしない場合は,falseを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数qnameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数qnameに指定されたQNameの文字列表現が不正なフォーマットの場合にスローされます。[エラーコード:25000]
  • 引数qnameに指定されたQNameの文字列表現に不正な文字が含まれている場合にスローされます。[エラーコード:25008,25009]

(4) XBRLQName

public  XBRLQName(java.lang.String namespaceURI,
                 java.lang.String localPart,
                 boolean validate)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間URIおよびローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを構築します。
引数validateにtrueが指定された場合だけ,名前空間URIとローカルパートに指定された文字列に不正な文字が含まれるかどうかをチェックします。その場合,引数namespaceURIおよびlocalPartには,それぞれXML Schemaのデータ型anyURIおよびNCNameとして妥当な文字列だけを指定できます。ただし,引数namespaceURIに空文字列("")は指定できません。
引数:
namespaceURI - QNameの名前空間URIを指定します。名前空間URIがない場合は,nullを指定します。
localPart - QNameのローカルパートを指定します。
validate - 名前空間URIおよびローカルパートに指定された文字列に不正な文字が含まれているかどうかをチェックする場合は,trueを指定します。チェックしない場合は,falseを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数localPartにnullまたは空文字列("")を指定した場合にスローされます。[エラーコード:20002,25000]
  • 引数namespaceURIに指定した名前空間URI,または引数localPartに指定したローカルパートに不正な文字が含まれている場合にスローされます。[エラーコード:25008,25009]

(5) getNamespaceURI

public java.lang.String getNamespaceURI()

XBRLのバージョン:
2.0および2.1
説明:
QNameの名前空間URIを取得します。
戻り値:
QNameの名前空間URIを返します。名前空間URIがない場合はnullを返します。

(6) getLocalPart

public java.lang.String getLocalPart()

XBRLのバージョン:
2.0および2.1
説明:
QNameのローカルパートを取得します。
戻り値:
QNameのローカルパートを返します。

(7) toString

public java.lang.String toString()

XBRLのバージョン:
2.0および2.1
説明:
QNameの文字列表現を取得します。QNameの文字列表現は,"{namespaceURI}localPart"です。"{namespaceURI}"の部分は省略できます。
オーバーライド:
クラスjava.lang.Object内のtoString()
戻り値:
QNameの文字列表現を返します。

(8) toString

public static java.lang.String toString(java.lang.String namespaceURI,
                                       java.lang.String localPart)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間URIおよびローカルパートで構成される,QNameの文字列表現を取得します。QNameの文字列表現は,"{namespaceURI}localPart"です。"{namespaceURI}"の部分は省略できます。
このメソッドでは,引数namespaceURIおよびlocalPartで指定した文字列に不正な文字が含まれるかどうかはチェックしません。
引数:
namespaceURI -QNameの名前空間URIを指定します。名前空間URIがない場合は,nullを指定します。
localPart - QNameのローカルパートを指定します。
戻り値:
指定した名前空間URIとローカルパートで構成されるQNameの文字列表現を返します。
例外:
XBRLDOMRuntimeException -
  • 引数localPartにnullまたは空文字列("")を指定した場合にスローされます。[エラーコード:20002,25000]

(9) valueOf

public static XBRLQName valueOf(java.lang.String qname)

XBRLのバージョン:
2.0および2.1
説明:
指定したQNameの文字列表現からXBRLQNameオブジェクトを取得します。QNameの文字列表現は,"{namespaceURI}localPart"です。"{namespaceURI}"の部分は省略できます。
このメソッドでは,引数qnameで指定したQNameの文字列表現に不正な文字が含まれるかどうかはチェックしません。
引数:
qname - QNameの文字列表現を指定します。
戻り値:
指定したQNameの文字列表現から生成されたXBRLQNameオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数qnameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数qnameに指定したQNameの文字列表現が不正なフォーマットの場合にスローされます。[エラーコード:25000]

(10) valueOf

public static XBRLQName valueOf(java.lang.String namespaceURI,
                               java.lang.String localPart)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前空間URIとローカルパートで構成されるQNameを表すXBRLQNameオブジェクトを取得します。
このメソッドでは,引数namespaceURIおよびlocalPartで指定した文字列に,不正な文字が含まれるかどうかはチェックしません。
引数:
namespaceURI - QNameの名前空間URIを指定します。名前空間URIがない場合は,nullを指定します。
localPart - QNameのローカルパートを指定します。
戻り値:
指定した名前空間URIとローカルパートから生成されたXBRLQNameオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数localPartにnullまたは空文字列("")を指定した場合にスローされます。[エラーコード:20002,25000]

(11) equals

public boolean equals(java.lang.Object obj)

XBRLのバージョン:
2.0および2.1
説明:
XBRLQNameオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
オーバーライド:
クラスjava.lang.Object内のequals()
引数:
obj - このXBRLQNameオブジェクトと比較するオブジェクトを指定します。
戻り値:
このXBRLQNameオブジェクトが,引数objで指定したオブジェクトと等しい場合はtrue,等しくない場合はfalseを返します。

(12) hashCode

public int hashCode()

XBRLのバージョン:
2.0および2.1
説明:
XBRLQNameオブジェクトのハッシュコードを取得します。
オーバーライド:
クラスjava.lang.Object内のhashCode()
戻り値:
このXBRLQNameオブジェクトのハッシュコードを返します。