HijrahEra (ThreeTen backport for java.time package 1.0.0 API)

java.lang.Object
- java.lang.Enum<HijrahEra>
- - java.time.chrono.HijrahEra

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HijrahEra>, Era, TemporalAccessor, TemporalAdjuster
```
public enum HijrahEra
extends java.lang.Enum<HijrahEra>
implements Era
```
An era in the Hijrah calendar system.
The Hijrah calendar system has two eras. The date 0001-01-01 (Hijrah) is 622-06-19 (ISO).
Do not use ordinal() to obtain the numeric representation of HijrahEra. Use getValue() instead.
Specification for implementors
This is an immutable and thread-safe enum.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AH` The singleton instance for the current era, 'Anno Hegirae', which has the value 1.
`BEFORE_AH` The singleton instance for the era before the current one, 'Before Anno Hegirae', which has the value 0.

Method Summary

Methods
Modifier and Type	Method and Description
`Temporal`	`adjustInto(Temporal temporal)` Adjusts the specified temporal object.
`int`	`get(TemporalField field)` Gets the value of the specified field as an `int`.
`java.lang.String`	`getDisplayName(TextStyle style, java.util.Locale locale)` Gets the textual representation of this era.
`long`	`getLong(TemporalField field)` Gets the value of the specified field as a `long`.
`int`	`getValue()` Gets the era numeric value.
`boolean`	`isSupported(TemporalField field)` Checks if the specified field is supported.
`static HijrahEra`	`of(int hijrahEra)` Obtains an instance of `HijrahEra` from a value.
`<R> R`	`query(TemporalQuery<R> query)` Queries this date-time.
`ValueRange`	`range(TemporalField field)` Gets the range of valid values for the specified field.
`static HijrahEra`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static HijrahEra[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - BEFORE_AH
```
public static final HijrahEra BEFORE_AH
```
    The singleton instance for the era before the current one, 'Before Anno Hegirae', which has the value 0.
  - AH
```
public static final HijrahEra AH
```
    The singleton instance for the current era, 'Anno Hegirae', which has the value 1.
- Method Detail
  - values
```
public static HijrahEra[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (HijrahEra c : HijrahEra.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HijrahEra valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - of
```
public static HijrahEra of(int hijrahEra)
```
    Obtains an instance of HijrahEra from a value.
    The current era (from ISO date 622-06-19 onwards) has the value 1 The previous era has the value 0.
    
    Parameters:
    hijrahEra - the era to represent, from 0 to 1
    
    Returns:
    the HijrahEra singleton, never null
    
    Throws:
    
    DateTimeException - if the era is invalid
  - getValue
```
public int getValue()
```
    Gets the era numeric value.
    The current era (from ISO date 622-06-19 onwards) has the value 1. The previous era has the value 0.
    
    Specified by:
    
    getValue in interface Era
    
    Returns:
    the era value, from 0 (BEFORE_AH) to 1 (AH)
  - isSupported
```
public boolean isSupported(TemporalField field)
```
    Description copied from interface: TemporalAccessor
    
    Checks if the specified field is supported.
    This checks if the date-time can be queried for the specified field. If false, then calling the range and get methods will throw an exception.
    Specification for implementors
    Implementations must check and handle all fields defined in ChronoField. If the field is supported, then true is returned, otherwise false
    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument.
    Implementations must not alter this object.
    
    Specified by:
    
    isSupported in interface TemporalAccessor
    
    Parameters:
    field - the field to check, null returns false
    
    Returns:
    true if this date-time can be queried for the field, false if not
  - range
```
public ValueRange range(TemporalField field)
```
    Description copied from interface: TemporalAccessor
    
    Gets the range of valid values for the specified field.
    All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.
    Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.
    Specification for implementors
    Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the range of the field must be returned. If unsupported, then a DateTimeException must be thrown.
    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessorl) passing this as the argument.
    Implementations must not alter either this object.
    
    Specified by:
    
    range in interface TemporalAccessor
    
    Parameters:
    field - the field to query the range for, not null
    
    Returns:
    the range of valid values for the field, not null
  - get
```
public int get(TemporalField field)
```
    Description copied from interface: TemporalAccessor
    
    Gets the value of the specified field as an int.
    This queries the date-time for the value for the specified field. The returned value will always be within the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
    Specification for implementors
    Implementations must check and handle all fields defined in ChronoField. If the field is supported and has an int range, then the value of the field must be returned. If unsupported, then a DateTimeException must be thrown.
    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument.
    Implementations must not alter either this object.
    
    Specified by:
    
    get in interface TemporalAccessor
    
    Parameters:
    field - the field to get, not null
    
    Returns:
    the value for the field, within the valid range of values
  - getLong
```
public long getLong(TemporalField field)
```
    Description copied from interface: TemporalAccessor
    
    Gets the value of the specified field as a long.
    This queries the date-time for the value for the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
    Specification for implementors
    Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the value of the field must be returned. If unsupported, then a DateTimeException must be thrown.
    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument.
    Implementations must not alter either this object.
    
    Specified by:
    
    getLong in interface TemporalAccessor
    
    Parameters:
    field - the field to get, not null
    
    Returns:
    the value for the field
  - adjustInto
```
public Temporal adjustInto(Temporal temporal)
```
    Description copied from interface: TemporalAdjuster
    Adjusts the specified temporal object.
    This adjusts the specified temporal object using the logic encapsulated in the implementing class. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month.
    There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use Temporal.with(TemporalAdjuster):
```
   // these two lines are equivalent, but the second approach is recommended
   temporal = thisAdjuster.adjustInto(temporal);
   temporal = temporal.with(thisAdjuster);
 
```
    It is recommended to use the second approach, with(TemporalAdjuster), as it is a lot clearer to read in code.
    Specification for implementors
    The implementation must take the input object and adjust it. The implementation defines the logic of the adjustment and is responsible for documenting that logic. It may use any method on Temporal to query the temporal object and perform the adjustment. The returned object must have the same observable type as the input object
    The input object must not be altered. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable temporal objects.
    The input temporal object may be in a calendar system other than ISO. Implementations may choose to document compatibility with other calendar systems, or reject non-ISO temporal objects by querying the chronology.
    This method may be called from multiple threads in parallel. It must be thread-safe when invoked.
    Specified by:
    
    adjustInto in interface TemporalAdjuster
    
    Parameters:
    temporal - the temporal object to adjust, not null
    
    Returns:
    an object of the same observable type with the adjustment made, not null
  - query
```
public <R> R query(TemporalQuery<R> query)
```
    Description copied from interface: TemporalAccessor
    Queries this date-time.
    This queries this date-time using the specified query strategy object.
    Queries are a key tool for extracting information from date-times. They exists to externalize the process of querying, permitting different approaches, as per the strategy design pattern. Examples might be a query that checks if the date is the day before February 29th in a leap year, or calculates the number of days to your next birthday.
    The most common query implementations are method references, such as LocalDate::from and ZoneId::from. Further implementations are on TemporalQueries. Queries may also be defined by applications.
    Specification for implementors
    Implementations of this method must behave as follows:
```
   public <R> R query(TemporalQuery<R> type) {
     // only include an if statement if the implementation can return it
     if (query == TemporalQueries.zoneId())  return // the ZoneId
     if (query == TemporalQueries.chronology())  return // the Chrono
     if (query == TemporalQueries.precision())  return // the precision
     // call default method
     return super.query(query);
   }
 
```
    Specified by:
    
    query in interface TemporalAccessor
    
    Type Parameters:
    R - the type of the result
    Parameters:
    query - the query to invoke, not null
    
    Returns:
    the query result, null may be returned (defined by the query)
  - getDisplayName
```
public java.lang.String getDisplayName(TextStyle style,
                              java.util.Locale locale)
```
    Description copied from interface: Era
    
    Gets the textual representation of this era.
    This returns the textual name used to identify the era. The parameters control the style of the returned text and the locale.
    If no textual mapping is found then the numeric value is returned.
    
    Specified by:
    
    getDisplayName in interface Era
    
    Parameters:
    style - the style of the text required, not null
    locale - the locale to use, not null
    
    Returns:
    the text value of the era, not null

Enum HijrahEra

Specification for implementors

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BEFORE_AH

AH

Method Detail

values

valueOf

of

getValue

isSupported

Specification for implementors

range

Specification for implementors

get

Specification for implementors

getLong

Specification for implementors

adjustInto

Specification for implementors

query

Specification for implementors

getDisplayName