6.9.4 XBRLDateクラス

public final class XBRLDate
extends java.lang.Object

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

表6-127 XBRLDateクラスのコンストラクタの概要

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

表6-128 XBRLDateクラスのメソッドの概要

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

(1) XBRLDate

public XBRLDate(java.lang.String date)

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

dateFormat ::= ('-')?(date | date timezone)
date ::= year '-' month '-' day
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]

yearには「0」を指定できません。dayについては,BNF表記で表現できない月ごとの最大値もチェックします。うるう年も考慮してチェックします。
引数:
date - date型データの文字列表現を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数dateにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数dateに指定したdate型データの文字列表現が不正な場合にスローされます。[エラーコード:25000]

(2) XBRLDate

public  XBRLDate(XBRLDate other)

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

(3) XBRLDate

public  XBRLDate(XBRLDateTime other)

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

(4) compareTo

public int compareTo(XBRLDate other)

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

(5) toString

public java.lang.String toString()

XBRLのバージョン:
2.0および2.1
説明:
date型データの文字列表現を取得します。
オーバーライド:
クラスjava.lang.Object内のtoString()
戻り値:
このdate型データの文字列表現を返します。

(6) equals

public boolean equals(java.lang.Object obj)

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

(7) hashCode

public int hashCode()

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

(8) add

public XBRLDate add(XBRLDuration duration)

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