net.time4j.engine

Class BasicElement<V extends Comparable<V>>

java.lang.Object

net.time4j.engine.BasicElement<V>

Type Parameters:

V - generic type of element values

All Implemented Interfaces:

Serializable, Comparator<ChronoDisplay>, ChronoElement<V>

Direct Known Subclasses:

DisplayElement

public abstract class BasicElement<V extends Comparable<V>>
extends Object
implements ChronoElement<V>, Serializable

Abstract base implementation of a chronological element which has a name and can also define an (unregistered) element rule.

Author:

Meno Hochschild

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(ChronoDisplay o1, ChronoDisplay o2) Compares the values of this element based on their natural order.
boolean	equals(Object obj) Based on equality of element names AND element classes.
String	getDisplayName(Locale language) Obtains a localized name for display purposes if possible.
char	getSymbol() There is no format symbol by default.
int	hashCode() Based on the element name.
boolean	isLenient() Chronological elements are strict by default.
boolean	isLocal() Elements are local by default and can therefore not be used in a global context.
String	name() Returns the name which is unique within the context of a given chronology.
String	toString() Serves mainly for debugging support.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.engine.ChronoElement

getDefaultMaximum, getDefaultMinimum, getType, isDateElement, isTimeElement

Method Detail

name

public final String name()

Description copied from interface: ChronoElement

Returns the name which is unique within the context of a given chronology.

The name can also serve as resource key together with the name of a chronology for a localized description.

Specified by:

name in interface ChronoElement<V extends Comparable<V>>

Returns:

name of element, unique within a chronology

getDisplayName

public String getDisplayName(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<V extends Comparable<V>>

Parameters:

language - language setting

Returns:

localized name or if not available then a technical name will be chosen

compare

public int compare(ChronoDisplay o1,
          ChronoDisplay o2)

Compares the values of this element based on their natural order.

Specified by:

compare in interface Comparator<ChronoDisplay>

Specified by:

compare in interface ChronoElement<V extends Comparable<V>>

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

Throws:

ChronoException - if this element is not registered in any entity and/or if no element rule exists to extract the element value

Since:

3.5/4.3

getSymbol

public char getSymbol()

There is no format symbol by default.

In order to define a format symbol subclasses must override this methode. In that case such an element instance should be annotated with the annotation FormattableElement for documentation support.

Specified by:

getSymbol in interface ChronoElement<V extends Comparable<V>>

Returns:

ASCII-0 (placeholder for an undefined format symbol)

See Also:

FormattableElement

isLenient

public boolean isLenient()

Chronological elements are strict by default.

Specified by:

isLenient in interface ChronoElement<V extends Comparable<V>>

Returns:

false

See Also:

ElementRule.withValue(T, V, boolean)

isLocal

public boolean isLocal()

Elements are local by default and can therefore not be used in a global context.

Returns:

true

Since:

2.0

See Also:

BasicElement.getVeto(Chronology)

equals

public final boolean equals(Object obj)

Based on equality of element names AND element classes.

Specified by:

equals in interface Comparator<ChronoDisplay>

Overrides:

equals in class Object

Returns:

true if this instance and the argument are of same class and have same names else false

hashCode

public final int hashCode()

Based on the element name.

Overrides:

hashCode in class Object

Returns:

int

toString

public String toString()

Serves mainly for debugging support.

For display purpose the method BasicElement.name() is to be preferred.

Overrides:

toString in class Object

Returns:

String