CalendarVariant (time4j-android 3.6-2015f API)

java.lang.Object
- net.time4j.engine.ChronoEntity<D>
- - net.time4j.engine.CalendarVariant<D>

Type Parameters:

D - generic type of self reference

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<D>, ChronoDisplay, Temporal<CalendarVariant<?>>

Direct Known Subclasses:

HijriCalendar
```
public abstract class CalendarVariant<D extends CalendarVariant<D>>
extends ChronoEntity<D>
implements java.lang.Comparable<D>, Temporal<CalendarVariant<?>>, java.io.Serializable
```
Represents an immutable calendar variant.

Display and change chronological element values

The calendar variant consists of chronological elements. This base class delegates the elment and time arithmetic to the associated calendar family respective to the underlying rules of elements and units. However, any concrete subclass is required to define the state and reflect it in all get()-methods and also to specify the serialization behaviour.

Element values can only be changed by creating a new immutable copy of the original instance. This is done via all with()-methods.

Calendar system

Every calendar variant is a member of a calendar family. That means referring to a calendar system via a variant name. Hence a limited day arithmetic using the class CalendarDays is always possible.

Sorting

The sorting algorithm prefers the temporal order then the lexicographical comparison based on variant names. In case of doubt the documentation of the subclass is leading. Alternatively, the interface Temporal can be used to enable a pure temporal order.

Implementation notes
- All subclasses must be final und immutable.
- Documentation of supported and registered elements is required.
- The natural order should be consistent with equals().
Since:

3.4/4.3

See Also:

Chronology, CalendarFamily

Constructor Summary

Constructors
Constructor and Description

CalendarVariant()

Constructors
Constructor and Description
`CalendarVariant()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(D calendarVariant)` Compares two calendar variants preferably by their temporal positions on the common date axis and then by their variant names.
`abstract boolean`	`equals(java.lang.Object obj)` Compares the whole state of this instance with given object.
`abstract java.lang.String`	`getVariant()` Returns the name of the associated variant of underlying calendar system.
`abstract int`	`hashCode()` Subclasses must redefine this method corresponding to the behaviour of `equals()`.
`boolean`	`isAfter(CalendarVariant<?> other)` Queries if this object is after given object on a timeline.
`boolean`	`isBefore(CalendarVariant<?> other)` Queries if this object is before given object on a timeline.
`boolean`	`isSimultaneous(CalendarVariant<?> other)` Queries if this object and given object have the same position on the time axis.
`D`	`minus(CalendarDays days)` Subtracts given calendar days from this instance.
`D`	`plus(CalendarDays days)` Adds given calendar days to this instance.
`abstract java.lang.String`	`toString()` Provides a complete textual representation of the state of this calendar variant.
`<T extends Calendrical<?,T>> T`	`transform(java.lang.Class<T> target)` Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].
`<T extends CalendarVariant<T>> T`	`transform(java.lang.Class<T> target, java.lang.String variant)` Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].
`<T extends CalendarVariant<T>> T`	`transform(java.lang.Class<T> target, VariantSource variantSource)` Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].

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

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

- Constructor Detail
  - CalendarVariant
```
public CalendarVariant()
```
- Method Detail
  - getVariant
```
public abstract java.lang.String getVariant()
```
    Returns the name of the associated variant of underlying calendar system.
    
    Returns:
    
    String
    
    Since:
    
    3.4/4.3
    
    See Also:
    
    CalendarFamily.getCalendarSystem(String)
  - transform
```
public <T extends Calendrical<?,T>> T transform(java.lang.Class<T> target)
```
    Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].
    
    The conversion occurs on the local timeline at noon. This reference time ensures that all date types remain convertible even if a calendar system defines dates not starting at midnight.
    
    Type Parameters:
    
    T - generic target date type
    
    Parameters:
    
    target - chronological type this date shall be converted to
    
    Returns:
    
    converted date of target type T
    
    Throws:
    
    java.lang.IllegalArgumentException - if the target class does not have any chronology
    
    java.lang.ArithmeticException - in case of numerical overflow
    
    Since:
    
    3.5/4.3
  - transform
```
public <T extends CalendarVariant<T>> T transform(java.lang.Class<T> target,
                                                  java.lang.String variant)
```
    Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].
    
    The conversion occurs on the local timeline at noon. This reference time ensures that all date types remain convertible even if a calendar system defines dates not starting at midnight.
    
    Type Parameters:
    
    T - generic target date type
    
    Parameters:
    
    target - chronological type this date shall be converted to
    
    variant - desired calendar variant
    
    Returns:
    
    converted date of target type T
    
    Throws:
    
    ChronoException - if given variant is not recognized
    
    java.lang.IllegalArgumentException - if the target class does not have any chronology
    
    java.lang.ArithmeticException - in case of numerical overflow
    
    Since:
    
    3.5/4.3
  - transform
```
public <T extends CalendarVariant<T>> T transform(java.lang.Class<T> target,
                                                  VariantSource variantSource)
```
    Converts this calendar date to the given target type based on the count of days relative to UTC epoch [1972-01-01].
    
    The conversion occurs on the local timeline at noon. This reference time ensures that all date types remain convertible even if a calendar system defines dates not starting at midnight.
    
    Type Parameters:
    
    T - generic target date type
    
    Parameters:
    
    target - chronological type this date shall be converted to
    
    variantSource - source of desired calendar variant
    
    Returns:
    
    converted date of target type T
    
    Throws:
    
    ChronoException - if given variant is not recognized
    
    java.lang.IllegalArgumentException - if the target class does not have any chronology
    
    java.lang.ArithmeticException - in case of numerical overflow
    
    Since:
    
    3.6/4.4
  - compareTo
```
public int compareTo(D calendarVariant)
```
    Compares two calendar variants preferably by their temporal positions on the common date axis and then by their variant names.
    
    Implementation note: In order to make the natural order consistent with equals() the whole state must be taken into account, with preference for those attributes which define the temporal position on the time axis.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<D extends CalendarVariant<D>>
    
    Parameters:
    
    calendarVariant - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    See Also:
    
    equals(Object)
  - isAfter
```
public boolean isAfter(CalendarVariant<?> other)
```
    Description copied from interface: Temporal
    
    Queries if this object is after given object on a timeline.
    
    Specified by:
    
    isAfter in interface Temporal<CalendarVariant<?>>
    
    Parameters:
    
    other - object this instance is compared to
    
    Returns:
    
    true if this instance is temporally after temporal else false
  - isBefore
```
public boolean isBefore(CalendarVariant<?> other)
```
    Description copied from interface: Temporal
    
    Queries if this object is before given object on a timeline.
    
    Specified by:
    
    isBefore in interface Temporal<CalendarVariant<?>>
    
    Parameters:
    
    other - object this instance is compared to
    
    Returns:
    
    true if this instance is temporally before temporal else false
  - isSimultaneous
```
public boolean isSimultaneous(CalendarVariant<?> other)
```
    Description copied from interface: Temporal
    
    Queries if this object and given object have the same position on the time axis.
    
    Is equivalent to !isAfter(temporal) && !isBefore(temporal). This method differs from the Object-method equals() such that first the comparison type must be a temporal one and second that only temporal-only state will be considered.
    
    Specified by:
    
    isSimultaneous in interface Temporal<CalendarVariant<?>>
    
    Parameters:
    
    other - object this instance is compared to
    
    Returns:
    
    true if this instance is temporally equal to temporal else false
  - plus
```
public D plus(CalendarDays days)
```
    Adds given calendar days to this instance.
    
    Parameters:
    
    days - calendar days to be added
    
    Returns:
    
    result of addition
    
    Since:
    
    3.4/4.3
  - minus
```
public D minus(CalendarDays days)
```
    Subtracts given calendar days from this instance.
    
    Parameters:
    
    days - calendar days to be subtracted
    
    Returns:
    
    result of subtraction
    
    Since:
    
    3.4/4.3
  - equals
```
public abstract boolean equals(java.lang.Object obj)
```
    Compares the whole state of this instance with given object.
    
    Implementations will usually define their state based on the temporal position and the variant name. Exceptions from this rule should be explicitly documented and reasoned.
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    compareTo(CalendarVariant)
  - hashCode
```
public abstract int hashCode()
```
    Subclasses must redefine this method corresponding to the behaviour of equals().
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public abstract java.lang.String toString()
```
    Provides a complete textual representation of the state of this calendar variant.
    
    Overrides:
    
    toString in class java.lang.Object

Class CalendarVariant<D extends CalendarVariant<D>>

Constructor Summary

Method Summary

Methods inherited from class net.time4j.engine.ChronoEntity

Methods inherited from class java.lang.Object

Constructor Detail

CalendarVariant

Method Detail

getVariant

transform

transform

transform

compareTo

isAfter

isBefore

isSimultaneous

plus

minus

equals

hashCode

toString