6.9.5 XBRLDateTimeクラス

public final class XBRLDateTime
extends java.lang.Object

XBRLのバージョン:
2.0および2.1
説明:
XML Schemaのデータ型dateTimeを表します。
注 このクラスはequals()と一貫性のない,自然順序づけを持ちます。
コンストラクタの概要:
XBRLDateTimeクラスのコンストラクタの概要を次の表に示します。

表6-129 XBRLDateTimeクラスのコンストラクタの概要

項番説明XBRLのバージョン
1XBRLDateTime(java.lang.String datetime)
  指定したdateTime型データの文字列表現から,XBRLDateTimeオブジェクトを構築します。
2.0および2.1
2XBRLDateTime(XBRLDateTime other)
  指定したXBRLDateTimeオブジェクトから,XBRLDateTimeオブジェクトを新規に構築します。
2.0および2.1
3XBRLDateTime(XBRLDate other)
  指定したXBRLDateTimeオブジェクトから,時間が"00:00:00.000"で始まるXBRLDateTimeオブジェクトを新規に構築します。
2.0および2.1
メソッドの概要:
XBRLDateTimeクラスのメソッドの概要を次の表に示します。

表6-130 XBRLDateTimeクラスのメソッドの概要

項番説明XBRLのバージョン
1intcompareTo(XBRLDateTime other)
  XBRLDateTimeオブジェクトとほかのXBRLDateTimeオブジェクトを比較します。
2.0および2.1
2java.lang.StringtoString()
  dateTime型データの文字列表現を取得します。
2.0および2.1
3booleanequals(java.lang.Object obj)
  XBRLDateTimeオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
2.0および2.1
4inthashCode()
  XBRLDateTimeオブジェクトのハッシュコードを取得します。
2.0および2.1
5XBRLDateTimeadd(XBRLDuration duration)
  指定したXBRLDurationオブジェクトを加算したXBRLDateTimeオブジェクトを,新規に取得します。
2.0および2.1
<この項の構成>
(1) XBRLDateTime
(2) XBRLDateTime
(3) XBRLDateTime
(4) compareTo
(5) toString
(6) equals
(7) hashCode
(8) add

(1) XBRLDateTime

public  XBRLDateTime(java.lang.String datetime)

XBRLのバージョン:
2.0および2.1
説明:
指定したdateTime型データの文字列から,XBRLDateTimeオブジェクトを構築します。次の文字列表現だけを指定できます。文字列表現が不正な場合は例外がスローされます。
指定できる文字列表現:BNF表記

datetimeFormat ::= ('-')?(date | date timezone)
date ::= year '-' month '-' day 'T' hour ':' minute ':' second
timezone ::= 'Z' | ('+'|'-') hour ':' minute
year ::= ([0-9])*[0-9][0-9][0-9][0-9]
month ::= [0][1-9] | [1][0-2]
day ::= [0][1-9] | [1-2][0-9] | [3][0-1]
hour ::= [0-1][0-9] | [2][0-3]
minute ::= [0-5][0-9]
second ::= [0-5][0-9] | [0-5][0-9]'.'([0-9])+

yearには「0」を指定できません。dayについては,BNF表記で表現できない月ごとの最大値もチェックします。うるう年も考慮してチェックします。うるう秒は考慮しません。
秒以下の値は,小数第4桁で四捨五入しミリ秒単位に丸めます。このためオブジェクト構築時に指定した文字列表現と,toStringによって取得した文字列表現が異なることがあります。
引数:
datetime - dateTime型データの文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数datetimeにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数datetimeに指定したdateTime型データの文字列表現が不正な場合にスローされます。[エラーコード:25000]

(2) XBRLDateTime

public  XBRLDateTime(XBRLDateTime other)

XBRLのバージョン:
2.0および2.1
説明:
指定したXBRLDateTimeオブジェクトから,XBRLDateTimeオブジェクトを新規に構築します。
引数:
other - XBRLDateTimeオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数otherにnullを指定した場合にスローされます。[エラーコード:20002]

(3) XBRLDateTime

public  XBRLDateTime(XBRLDate other)

XBRLのバージョン:
2.0および2.1
説明:
指定したXBRLDateTimeオブジェクトから,XBRLDateTimeオブジェクトを新規に構築します。新たなXBRLDateTimeオブジェクトの時間は「00:00:00.000」となります。
引数:
other - XBRLDateオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数otherにnullを指定した場合にスローされます。[エラーコード:20002]

(4) compareTo

public int compareTo(XBRLDateTime other)

XBRLのバージョン:
2.0および2.1
説明:
XBRLDateTimeオブジェクトとほかのXBRLDateTimeオブジェクトを比較します。
タイムゾーンオフセットを反映した結果で比較します。タイムゾーン指定のないものについてはUTC(協定世界時)と仮定し,比較します。
注 このメソッドの実行結果とequals()とは一貫性がありません。
引数:
other - 比較対象のXBRLDateTimeオブジェクトを指定します。
戻り値:
このXBRLDateTimeオブジェクトが,引数otherで指定したXBRLDateTimeオブジェクトと等しい場合は0を返します。引数otherで指定したXBRLDateTimeオブジェクトよりも小さい場合は0より小さい値,大きい場合は0より大きい値を返します。

(5) toString

public java.lang.String toString()

XBRLのバージョン:
2.0および2.1
説明:
dateTime型データの文字列を取得します。
秒以下の値は必ず小数第3桁で表現します。このためオブジェクト構築時に指定した文字列表現と,toString()によって取得した文字列表現が異なることがあります。
オーバーライド:
クラスjava.lang.Object内のtoString()
戻り値:
このdateTime型データの文字列表現を返します。

(6) equals

public boolean equals(java.lang.Object obj)

XBRLのバージョン:
2.0および2.1
説明:
XBRLDateTimeオブジェクトとほかのオブジェクトが等しいかどうかを調べます。
タイムゾーンを含み同じ文字列表現となる場合だけを,等しいものとみなします。タイムゾーンオフセットを反映した結果が同じ値となる場合でも,タイムゾーンの表現方法が別表現の場合は異なるものとみなします。
注 このメソッドの実行結果とcompareTo()とは一貫性がありません。
オーバーライド:
クラスjava.lang.Object内のequals()
引数:
obj - このXBRLDateTimeオブジェクトと比較するオブジェクトを指定します。
戻り値:
このXBRLDateTimeオブジェクトが,引数objで指定したオブジェクトと等しい場合はtrue,等しくない場合はfalseを返します。

(7) hashCode

public int hashCode()

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

(8) add

public XBRLDateTime add(XBRLDuration duration)

XBRLのバージョン:
2.0および2.1
説明:
指定したXBRLDurationオブジェクトを加算したXBRLDateTimeオブジェクトを,新規に取得します。
引数:
duration - XBRLDurationオブジェクトを指定します。
戻り値:
指定したXBRLDurationオブジェクトを加算した,新たなXBRLDateTimeオブジェクトを返します。
例外:
XBRLDOMRuntimeException -
  • 引数durationにnullを指定した場合にスローされます。[エラーコード:20002]