FlagElement (time4j-android 3.39-2018a API)

java.lang.Object
- java.lang.Enum<FlagElement>
- - net.time4j.engine.FlagElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FlagElement>, java.util.Comparator<ChronoDisplay>, ChronoElement<java.lang.Boolean>
```
public enum FlagElement
extends java.lang.Enum<FlagElement>
implements ChronoElement<java.lang.Boolean>
```
A specialized element for indicating special state during parsing.

Since:

3.32/4.27

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DAYLIGHT_SAVING` Identifies a summer or winter time information in any parsed chronological entity.
`LEAP_SECOND` Identifies the existence of a leap second in any parsed chronological entity.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(ChronoDisplay o1, ChronoDisplay o2)` Applies an element-orientated sorting of any chronological entities.
`java.lang.Boolean`	`getDefaultMaximum()` Returns the default maximum of this element which is not dependent on the chronological context.
`java.lang.Boolean`	`getDefaultMinimum()` Returns the default minimum of this element which is not dependent on the chronological context.
`java.lang.String`	`getDisplayName(java.util.Locale language)` Obtains a localized name for display purposes if possible.
`char`	`getSymbol()` Defines the default format symbol which is used in format patterns to refer to this element.
`java.lang.Class<java.lang.Boolean>`	`getType()` Yields the reified value type.
`boolean`	`isDateElement()` Queries if this element represents a calendar date element.
`boolean`	`isLenient()` Queries if setting of element values is performed in a lenient way.
`boolean`	`isTimeElement()` Queries if this element represents a wall time element.
`static FlagElement`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static FlagElement[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

Methods inherited from interface net.time4j.engine.ChronoElement
name

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Enum Constant Detail
  - LEAP_SECOND
```
public static final FlagElement LEAP_SECOND
```
    Identifies the existence of a leap second in any parsed chronological entity.
  - DAYLIGHT_SAVING
```
public static final FlagElement DAYLIGHT_SAVING
```
    Identifies a summer or winter time information in any parsed chronological entity.
- Method Detail
  - values
```
public static FlagElement[] 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 (FlagElement c : FlagElement.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FlagElement 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
  - getType
```
public java.lang.Class<java.lang.Boolean> getType()
```
    Description copied from interface: ChronoElement
    
    Yields the reified value type.
    
    Specified by:
    
    getType in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    type of associated values
  - getSymbol
```
public char getSymbol()
```
    Description copied from interface: ChronoElement
    
    Defines the default format symbol which is used in format patterns to refer to this element.
    
    In most cases the symbol should closely match the symbol-mapping as defined by the CLDR-standard of unicode-organization. Is the element not designed for formatting using patterns then this method just yields the ASCII-char "" (Codepoint 0).
    
    Specified by:
    
    getSymbol in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    format symbol as char
    
    See Also:
    
    FormattableElement
  - compare
```
public int compare(ChronoDisplay o1,
                   ChronoDisplay o2)
```
    Description copied from interface: ChronoElement
    
    Applies an element-orientated sorting of any chronological entities.
    
    The value type V is usually a subtype of the interface Comparable so that this method will usually be based on the expression o1.get(this).compareTo(o2.get(this)). In other words, this method compares the element values of given chronological entities. It is even permitted to compare entities of different chronological types as long as the entities both support this element.
    
    It should be noted however that a element value comparison does often not induce any temporal (complete) order. Counter examples are the year of gregorian BC-era (reversed temporal order before Jesu birth) or the clock display of hours (12 is indeed the begin at midnight).
    
    Specified by:
    
    compare in interface java.util.Comparator<ChronoDisplay>
    
    Specified by:
    
    compare in interface ChronoElement<java.lang.Boolean>
    
    Parameters:
    
    o1 - the first object to be compared
    
    o2 - the second object to be compared
    
    Returns:
    
    a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second
  - getDefaultMinimum
```
public java.lang.Boolean getDefaultMinimum()
```
    Description copied from interface: ChronoElement
    
    Returns the default minimum of this element which is not dependent on the chronological context.
    
    Note: This minimum does not necessarily define a minimum for all possible circumstances but only the default minimum under normal conditions such that the default minimum always exists and can be used as prototypical value. An example is the start of day which is usually midnight in ISO-8601 and can only deviate in specialized timezone context.
    
    Specified by:
    
    getDefaultMinimum in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    default minimum value of element
    
    See Also:
    
    ChronoElement.getDefaultMaximum()
  - getDefaultMaximum
```
public java.lang.Boolean getDefaultMaximum()
```
    Description copied from interface: ChronoElement
    
    Returns the default maximum of this element which is not dependent on the chronological context.
    
    Note: This maximum does not necessarily define a maximum for all possible circumstances but only the default maximum under normal conditions. An example is the second of minute whose default maximum is 59 while the largest maximum can be 60 in context of UTC-leapseconds.
    
    Specified by:
    
    getDefaultMaximum in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    default maximum value of element
    
    See Also:
    
    ChronoElement.getDefaultMinimum()
  - isDateElement
```
public boolean isDateElement()
```
    Description copied from interface: ChronoElement
    
    Queries if this element represents a calendar date element.
    
    Specified by:
    
    isDateElement in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    boolean
    
    See Also:
    
    ChronoElement.isTimeElement()
  - isTimeElement
```
public boolean isTimeElement()
```
    Description copied from interface: ChronoElement
    
    Queries if this element represents a wall time element.
    
    Specified by:
    
    isTimeElement in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    boolean
    
    See Also:
    
    ChronoElement.isDateElement()
  - isLenient
```
public boolean isLenient()
```
    Description copied from interface: ChronoElement
    
    Queries if setting of element values is performed in a lenient way.
    
    Specified by:
    
    isLenient in interface ChronoElement<java.lang.Boolean>
    
    Returns:
    
    true if lenient else false (standard)
    
    See Also:
    
    ElementRule.withValue(T, V, boolean)
  - getDisplayName
```
public java.lang.String getDisplayName(java.util.Locale language)
```
    Description copied from interface: ChronoElement
    
    Obtains a localized name for display purposes if possible.
    
    Most elements have no localized names, but in case the i18n-module is loaded then elements like eras, years, quarters, months, weeks, day-of-month, day-of-week, am/pm, hour, minute and second do have localization support. The default implementation falls back to the technical element name.
    
    Note that the displayed name does not need to be unique for different elements. For example the localized names of PlainDate.MONTH_OF_YEAR and PlainDate.MONTH_AS_NUMBER are equal.
    
    Specified by:
    
    getDisplayName in interface ChronoElement<java.lang.Boolean>
    
    Parameters:
    
    language - language setting
    
    Returns:
    
    localized name or if not available then a technical name will be chosen

Enum FlagElement

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.time4j.engine.ChronoElement

Methods inherited from interface java.util.Comparator

Enum Constant Detail

LEAP_SECOND

DAYLIGHT_SAVING

Method Detail

values

valueOf

getType

getSymbol

compare

getDefaultMinimum

getDefaultMaximum

isDateElement

isTimeElement

isLenient

getDisplayName