LunisolarYear (AJD4JP 1.4.6.2019 API)

java.lang.Object
- ajd4jp.LunisolarYear

すべての実装されたインタフェース:

Serializable, Comparable<LunisolarYear>
```
public class LunisolarYear
extends Object
implements Comparable<LunisolarYear>, Serializable
```
旧暦の一年間を表します。旧暦取得処理の起点となるクラスです。
旧暦とは明治5(1872)年まで使用されていた天保暦を指し、太陰太陽暦に分類されます。
ただし、当時の天保暦は経験的な定数値を使用していたのに対し、現在一般に流通しているいわゆる「旧暦」は、天文学的に正確な値を使用しています。また、当時は京都の経度に基づいた時刻を使用していますが、現在は日本標準時の時刻を使用します。そのため、当時の天保暦と現在の「旧暦」では日付が異なる場合があります。
本クラスも、現在の「旧暦」に基づいた処理を行います。また、太陰太陽暦(旧暦)は以下の点で太陽暦(新暦)とは異なるため、本クラスを扱う場合、注意して下さい。
- 旧暦の１ヶ月の長さは、大の月(30日)と小の月(29日)のどちらかです。
- 旧暦では季節のずれを調整するために、数年に１度、閏月を設けます。
  通常、一年は12ヶ月ですが、閏月が入ると13ヶ月になります。
  1月、2月、3月、閏3月、4月 ... 12月
  のように、同じ数字が続けて２回登場します。
本クラスでは、冬至(11月)のみから月を決定します。本来は、春分、夏至、秋分も月の決定基準ですが、処理として実装していません。閏月が必要な場合、冬至の次に、最初に登場する中気(*1)を含まない月を採用します。

*1 中気
二十四節気の、雨水・春分・穀雨・小満・夏至・大暑・処暑・秋分・霜降・小雪・冬至・大寒のこと。
関連項目:

直列化された形式

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`compareTo(LunisolarYear y)` 年の比較。
`boolean`	`equals(Object o)` 年の比較。
`int`	`getLastDay(int mm, boolean leap_f)` 月の最終日(晦日つごもり)を返します。
`int`	`getLeapMonth()` 閏月の月を返します。
`LSCD`	`getLSCD(AJD dd)` 旧暦の日付を取得。
`LSCD`	`getLSCD(int mm, boolean leap_f, int dd)` 旧暦の日付を取得。
`LSCD`	`getLSCD(int mm, boolean leap_f, int dd, int hh, int mi, int ss)` 旧暦の日付を取得。
`static LunisolarYear`	`getLunisolarYear(AJD hint)` 旧暦の年の取得。
`static LunisolarYear`	`getLunisolarYear(int year)` 旧暦の年を取得。
`int`	`getMonthCount()` 月の総数を返します。
`int`	`getYear()` 旧暦の年を返します。
`int`	`hashCode()` ハッシュコード。
`String`	`toString()` 年を表す数字を返します。

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- メソッドの詳細
  - getLunisolarYear
```
public static LunisolarYear getLunisolarYear(AJD hint)
```
    旧暦の年の取得。新暦と旧暦は年始がずれるため、同じ年でない場合があります。
    
    パラメータ:
    
    hint - この日付が含まれる年を返す。
    
    戻り値:
    
    hintが含まれる年。
  - getLunisolarYear
```
public static LunisolarYear getLunisolarYear(int year)
                                      throws AJDException
```
    旧暦の年を取得。指定年のものを返します。
    ここで指定する年は、旧暦での年です。旧暦と新暦では年始年末の年が一致しません。
    
    パラメータ:
    
    year - 年。0は指定できません。
    
    戻り値:
    
    yearの年。
    
    例外:
    
    AJDException - 不正な年。
  - getYear
```
public int getYear()
```
    旧暦の年を返します。
    
    戻り値:
    
    年。
  - getLSCD
```
public LSCD getLSCD(AJD dd)
```
    旧暦の日付を取得。
    
    パラメータ:
    
    dd - 検索対象。時間も引き継ぎます。
    
    戻り値:
    
    ajdに対応する旧暦の日付。年の範囲外であればnull。
  - getMonthCount
```
public int getMonthCount()
```
    月の総数を返します。旧暦の1年は、12ヶ月の場合と13ヶ月(閏月を含む)の場合があります。
    
    戻り値:
    
    月の総数。
  - getLeapMonth
```
public int getLeapMonth()
```
    閏月の月を返します。
    
    戻り値:
    
    -1:平年、1～12:閏月。
  - getLastDay
```
public int getLastDay(int mm,
                      boolean leap_f)
               throws AJDException
```
    月の最終日(晦日つごもり)を返します。指定月が存在しないと例外が発生します。
    
    パラメータ:
    
    mm - 月。1～12。
    
    leap_f - true:閏月、false:平月。
    
    戻り値:
    
    その月の最終日。
    
    例外:
    
    AJDException - 不正な月。
  - getLSCD
```
public LSCD getLSCD(int mm,
                    boolean leap_f,
                    int dd)
             throws AJDException
```
    旧暦の日付を取得。指定月が存在しない、または指定日が存在しない場合、例外が発生します。
    時間は 00:00:00 になります。
    
    パラメータ:
    
    mm - 月。1～12。
    
    leap_f - true:閏月、false:平月。
    
    dd - 日。
    
    戻り値:
    
    旧暦の日付。
    
    例外:
    
    AJDException - 不正な月日。
  - getLSCD
```
public LSCD getLSCD(int mm,
                    boolean leap_f,
                    int dd,
                    int hh,
                    int mi,
                    int ss)
             throws AJDException
```
    旧暦の日付を取得。指定月が存在しない、または指定日が存在しない場合、例外が発生します。
    
    パラメータ:
    
    mm - 月。1～12。
    
    leap_f - true:閏月、false:平月。
    
    dd - 日。
    
    hh - 時。
    
    mi - 分。
    
    ss - 秒。
    
    戻り値:
    
    旧暦の日付。
    
    例外:
    
    AJDException - 不正な月日。
  - toString
```
public String toString()
```
    年を表す数字を返します。
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    年を文字列にしたもの。
  - compareTo
```
public int compareTo(LunisolarYear y)
```
    年の比較。
    
    定義:
    
    compareTo インタフェース内 Comparable<LunisolarYear>
    
    パラメータ:
    
    y - 年。
    
    戻り値:
    
    -1:this<y(thisが過去)、0:this==y、1:this>y(thisが未来)。
  - hashCode
```
public int hashCode()
```
    ハッシュコード。年をそのまま返します。
    
    オーバーライド:
    
    hashCode クラス内 Object
    
    戻り値:
    
    ハッシュコード。
  - equals
```
public boolean equals(Object o)
```
    年の比較。
    
    オーバーライド:
    
    equals クラス内 Object
    
    パラメータ:
    
    o - 比較対象。
    
    戻り値:
    
    true:年が一致、false:年が不一致。

クラス LunisolarYear

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

getLunisolarYear

getLunisolarYear

getYear

getLSCD

getMonthCount

getLeapMonth

getLastDay

getLSCD

getLSCD

toString

compareTo

hashCode

equals