AnnualDate (Time4J-Misc 3.23 API)

java.lang.Object
- net.time4j.engine.ChronoEntity<AnnualDate>
- - net.time4j.xml.AnnualDate

All Implemented Interfaces:

Serializable, Comparable<AnnualDate>, ChronoDisplay, Temporal<AnnualDate>, LocalizedPatternSupport
```
@CalendarType(value="iso8601")
public final class AnnualDate
extends ChronoEntity<AnnualDate>
implements Comparable<AnnualDate>, Temporal<AnnualDate>, LocalizedPatternSupport, Serializable
```
Represents a combination of month and day-of-month as XML-pendant for xsd:gMonthDay.

February, the 29th is always valid within the context of this class only.

Following elements which are declared as constants are registered by this class:
The calendar year is missing. Therefore this class cannot model a complete calendar date like PlainDate. For the same reason, a temporal arithmetic is not defined. The main purpose of this class is just modelling partial dates like birthdays etc. Formatting example for localized formatting styles:
```
    ChronoFormatter<AnnualDate> usStyle =
      ChronoFormatter.ofStyle(DisplayMode.SHORT, Locale.US, AnnualDate.chronology());
    ChronoFormatter<AnnualDate> germanStyle =
      ChronoFormatter.ofStyle(DisplayMode.SHORT, Locale.GERMANY, AnnualDate.chronology());
    System.out.println("US-format: " + usStyle.format(AnnualDate.of(9, 11))); // US-format: 9/11
    System.out.println("German: " + germanStyle.format(AnnualDate.of(9, 11))); // German: 11.9.
 
```
Note: The current annual date can be determined by an expression like: AnnualDate current = SystemClock.inLocalView().now(AnnualDate.chronology()).
Since:

3.22/4.18

Author:

Meno Hochschild

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ChronoElement<Integer>`	`DAY_OF_MONTH` Element with the day of month in the value range `1-28/29/30/31`.
`static ChronoElement<Integer>`	`MONTH_AS_NUMBER` Element with the calendar month in numerical form and the value range `1-12`.
`static ChronoElement<Month>`	`MONTH_OF_YEAR` Element with the calendar month as enum in the value range `JANUARY-DECEMBER`).

Method Summary

Methods
Modifier and Type	Method and Description
`ChronoOperator<PlainDate>`	`asNextExactEvent()` Determines the next possible exact annual date.
`ChronoOperator<PlainDate>`	`asNextRoundedEvent()` Determines the next possible annual date and rounds up to next day if necessary.
`PlainDate`	`atYear(int year)` Creates a complete ISO calendar date for given gregorian year.
`static Chronology<AnnualDate>`	`chronology()` Yields the associated chronology.
`int`	`compareTo(AnnualDate other)`
`boolean`	`equals(Object obj)`
`int`	`getDayOfMonth()` Obtains the day of month.
`Month`	`getMonth()` Obtains the gregorian month.
`int`	`hashCode()`
`boolean`	`isAfter(AnnualDate temporal)`
`boolean`	`isBefore(AnnualDate temporal)`
`boolean`	`isSimultaneous(AnnualDate temporal)`
`boolean`	`isValidDate(int year)` Checks if this instance results in a valid ISO calendar date for given gregorian year.
`static AnnualDate`	`of(int month, int dayOfMonth)` Creates a new annual date.
`static AnnualDate`	`of(Month month, int dayOfMonth)` Creates a new annual date.
`static AnnualDate`	`parseXML(String xml)` Parses given string to an annual date where the input is in XML-format "--MM-dd".
`String`	`toString()` Yields the full description in the XML-format "--MM-dd".

Methods inherited from class net.time4j.engine.ChronoEntity
contains, get, get, getInt, getMaximum, getMinimum, getRegisteredElements, getTimezone, hasTimezone, isValid, isValid, isValid, matches, with, with, with, with

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MONTH_OF_YEAR
```
@FormattableElement(format="M",
                    standalone="L")
public static final ChronoElement<Month> MONTH_OF_YEAR
```
    Element with the calendar month as enum in the value range JANUARY-DECEMBER).
  - MONTH_AS_NUMBER
```
public static final ChronoElement<Integer> MONTH_AS_NUMBER
```
    Element with the calendar month in numerical form and the value range 1-12.
    
    Normally the enum-variant is recommended due to clarity and type-safety. The enum-form can also be formatted as text.
    
    See Also:
    AnnualDate.MONTH_OF_YEAR
  - DAY_OF_MONTH
```
@FormattableElement(format="d")
public static final ChronoElement<Integer> DAY_OF_MONTH
```
    Element with the day of month in the value range 1-28/29/30/31.
- Method Detail
  - of
```
public static AnnualDate of(Month month,
            int dayOfMonth)
```
    Creates a new annual date.
    
    Parameters:
    month - gregorian month as enum
    dayOfMonth - the day of month in range 1-29/30/31
    
    Returns:
    new annual date
  - of
```
public static AnnualDate of(int month,
            int dayOfMonth)
```
    Creates a new annual date.
    
    Parameters:
    month - gregorian month in range 1-12
    dayOfMonth - the day of month in range 1-29/30/31
    
    Returns:
    new annual date
  - getMonth
```
public Month getMonth()
```
    Obtains the gregorian month.
    
    Returns:
    Month
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Obtains the day of month.
    
    Returns:
    int
  - isAfter
```
public boolean isAfter(AnnualDate temporal)
```
    Specified by:
    
    isAfter in interface Temporal<AnnualDate>
  - isBefore
```
public boolean isBefore(AnnualDate temporal)
```
    Specified by:
    
    isBefore in interface Temporal<AnnualDate>
  - isSimultaneous
```
public boolean isSimultaneous(AnnualDate temporal)
```
    Specified by:
    
    isSimultaneous in interface Temporal<AnnualDate>
  - compareTo
```
public int compareTo(AnnualDate other)
```
    Specified by:
    
    compareTo in interface Comparable<AnnualDate>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Yields the full description in the XML-format "--MM-dd".
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String compatible to lexical space of xsd:gMonthDay
    See Also:
    AnnualDate.parseXML(String)
  - parseXML
```
public static AnnualDate parseXML(String xml)
                           throws ParseException
```
    Parses given string to an annual date where the input is in XML-format "--MM-dd".
    
    Parameters:
    xml - string compatible to lexical space of xsd:gMonthDay
    
    Returns:
    AnnualDate
    
    Throws:
    
    ParseException - if parsing fails
    See Also:
    AnnualDate.toString()
  - atYear
```
public PlainDate atYear(int year)
```
    Creates a complete ISO calendar date for given gregorian year.
    
    Parameters:
    year - proleptic iso year [(-999,999,999)-999,999,999]
    
    Returns:
    new or cached calendar date instance
    
    Throws:
    
    IllegalArgumentException - if the year argument is out of range or if this instance represents the 29th of February and is not valid for given year
    See Also:
    AnnualDate.isValidDate(int)
  - isValidDate
```
public boolean isValidDate(int year)
```
    Checks if this instance results in a valid ISO calendar date for given gregorian year.
    
    Parameters:
    year - proleptic iso year [(-999,999,999)-999,999,999]
    
    Returns:
    true if the year argument is out of range or if this instance represents the 29th of February and is not valid for given year else false
    See Also:
    AnnualDate.atYear(int)
  - asNextExactEvent
```
public ChronoOperator<PlainDate> asNextExactEvent()
```
    Determines the next possible exact annual date.
    
    If this annual date is a leap day then the next date can be some years later. Example:
```
     System.out.println(PlainDate.of(2015, 2, 28).with(AnnualDate.of(Month.FEBRUARY, 29).asNextEvent()));
     // 2016-02-29
     System.out.println(PlainDate.of(2016, 2, 28).with(AnnualDate.of(Month.FEBRUARY, 29).asNextEvent()));
     // 2016-02-29
     System.out.println(PlainDate.of(2016, 2, 29).with(AnnualDate.of(Month.FEBRUARY, 29).asNextEvent()));
     // 2020-02-29
 
```
    Returns:
    chronological operator
    See Also:
    AnnualDate.asNextRoundedEvent()
  - asNextRoundedEvent
```
public ChronoOperator<PlainDate> asNextRoundedEvent()
```
    Determines the next possible annual date and rounds up to next day if necessary.
    
    If this annual date is a leap day then the next date can be advanced to begin of March. Example:
```
     System.out.println(PlainDate.of(2015, 2, 28).with(AnnualDate.of(Month.FEBRUARY, 29).asNextEvent()));
     // 2015-03-01
 
```
    Returns:
    chronological operator
    See Also:
    AnnualDate.asNextExactEvent()
  - chronology
```
public static Chronology<AnnualDate> chronology()
```
    Yields the associated chronology.
    
    Returns:
    the underlying rule engine

Class AnnualDate

Field Summary

Method Summary

Methods inherited from class net.time4j.engine.ChronoEntity

Methods inherited from class java.lang.Object

Field Detail

MONTH_OF_YEAR

MONTH_AS_NUMBER

DAY_OF_MONTH

Method Detail

of

of

getMonth

getDayOfMonth

isAfter

isBefore

isSimultaneous

compareTo

equals

hashCode

toString

parseXML

atYear

isValidDate

asNextExactEvent

asNextRoundedEvent

chronology