6.9.18 XBRLTimeクラス
public final class XBRLTime
extends java.lang.Object
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XML Schemaのデータ型timeを表します。
- 注 このクラスはequals()と一貫性のない,自然順序づけを持ちます。
- コンストラクタの概要:
- XBRLTimeクラスのコンストラクタの概要を次の表に示します。
表6-156 XBRLTimeクラスのコンストラクタの概要
説明 | XBRLのバージョン |
---|
XBRLTime(java.lang.String time) 指定したtime型データの文字列表現からXBRLTimeオブジェクトを構築します。 | 2.0および2.1 |
- メソッドの概要:
- XBRLTimeクラスのメソッドの概要を次の表に示します。
表6-157 XBRLTimeクラスのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | int | compareTo(XBRLTime other) XBRLTimeオブジェクトとほかのXBRLTimeオブジェクトを比較します。 | 2.0および2.1 |
2 | java.lang.String | toString() time型データの文字列表現を取得します。 | 2.0および2.1 |
3 | boolean | equals(java.lang.Object obj) XBRLTimeオブジェクトとほかのオブジェクトが等しいかどうかを調べます。 | 2.0および2.1 |
4 | int | hashCode() XBRLTimeオブジェクトのハッシュコードを取得します。 | 2.0および2.1 |
- <この項の構成>
- (1) XBRLTime
- (2) compareTo
- (3) toString
- (4) equals
- (5) hashCode
(1) XBRLTime
public XBRLTime(java.lang.String time)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 指定したtime型データの文字列表現からXBRLTimeオブジェクトを構築します。
- 次の文字列表現だけ指定できます。文字列表現が不正な場合は例外がスローされます。
- 指定できる文字列表現:BNF表記
timeFormat ::= time | time timezone)
time ::= hour ':' minute ':' second
timezone ::= 'Z' | ('+'|'-') hour ':' minute
hour ::= [0-1][0-9] | [2][0-3]
minute ::= [0-5][0-9]
second ::= [0-5][0-9] | [0-5][0-9]'.'([0-9])+
- 秒以下の値は,小数第4桁で四捨五入しミリ秒単位に丸めます。このためオブジェクト構築時に指定した文字列表現と,toString()によって取得した文字列表現が異なることがあります。
- 引数:
- time - time型データの文字列表現を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数timeにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数timeに指定したtime型データの文字列表現が不正な場合にスローされます。[エラーコード:25000]
(2) compareTo
public int compareTo(XBRLTime other)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLTimeオブジェクトとほかのXBRLTimeオブジェクトを比較します。
- タイムゾーンオフセットを反映した結果で比較します。タイムゾーン指定のないものについてはUTC(協定世界時)と仮定し,比較します。
- 注 このメソッドの実行結果とequals()とは一貫性がありません。
- 引数:
- other - 比較対象のXBRLTimeオブジェクトを指定します。
- 戻り値:
- このXBRLTimeオブジェクトが,引数otherで指定したXBRLTimeオブジェクトと等しい場合は0を返します。引数otherで指定したXBRLTimeオブジェクトよりも小さい場合は0より小さい値,大きい場合は0より大きい値を返します。
(3) toString
public java.lang.String toString()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- time型データの文字列表現を取得します。
- 秒以下の値は必ず小数第3桁で表現します。このためオブジェクト構築時に指定した文字列表現と,toString()によって取得した文字列表現が異なることがあります。
- オーバーライド:
- クラスjava.lang.Object内のtoString()
- 戻り値:
- このtime型データの文字列表現を返します。
(4) equals
public boolean equals(java.lang.Object obj)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLTimeオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
- タイムゾーンを含み同じ文字列表現となる場合だけ,等しいものとみなします。タイムゾーンオフセットを反映した結果が同じ値となる場合でも,タイムゾーンの表現方法が別表現の場合は異なるものとみなします。
- 注 このメソッドの実行結果とcompareTo()とは一貫性がありません。
- オーバーライド:
- クラスjava.lang.Object内のequals()
- 引数:
- obj - このXBRLTimeオブジェクトと比較するオブジェクトを指定します。
- 戻り値:
- このXBRLTimeオブジェクトが,引数objで指定したオブジェクトと等しい場合はtrue,等しくない場合はfalseを返します。
(5) hashCode
public int hashCode()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- XBRLTimeオブジェクトのハッシュコードを取得します。
- オーバーライド:
- クラスjava.lang.Object内のhashCode()
- 戻り値:
- XBRLTimeオブジェクトのハッシュコードを返します。