net.time4j.engine

Class AdvancedElement<V extends Comparable<V>>

java.lang.Object

net.time4j.engine.BasicElement<V>

net.time4j.engine.AdvancedElement<V>

Type Parameters:

V - generic type of element values

All Implemented Interfaces:

Serializable, Comparator<ChronoEntity<?>>, ChronoElement<V>

public abstract class AdvancedElement<V extends Comparable<V>>
extends BasicElement<V>

Default implementation of a chronological element with some element-related manipulation methods.

Author:

Meno Hochschild

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ChronoEntity<T>> ChronoOperator<T>	atCeiling(Class<T> context) Yields an operator which rounds any entity up so that the child elements will be set to the maximum.
<T extends ChronoEntity<T>> ChronoOperator<T>	atFloor(Class<T> context) Yields an operator which rounds any entity down so that the child elements will be set to the minimum.
int	compare(ChronoEntity<?> o1, ChronoEntity<?> o2) Compares the values of this element based on their natural order.
<T extends ChronoEntity<T>> ChronoOperator<T>	decremented(Class<T> context) Yields a new operator which can set any entity such that its actual element value gets the decremented value.
<T extends ChronoEntity<T>> ChronoOperator<T>	incremented(Class<T> context) Yields a new operator which can set any entity such that its actual element value gets the incremented value.
<T extends ChronoEntity<T>> ChronoOperator<T>	maximized(Class<T> context) Yields a new operator which can set any entity to its maximum element value.
<T extends ChronoEntity<T>> ChronoOperator<T>	minimized(Class<T> context) Yields a new operator which can set any entity to its minimum element value.
<T extends ChronoEntity<T>> ChronoOperator<T>	setLenient(V value, Class<T> context) Yields an operator which sets any entity such that its actual element value will be set in lenient mode to given value.

Methods inherited from class net.time4j.engine.BasicElement

equals, getSymbol, hashCode, isLenient, name, toString

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

compare

public int compare(ChronoEntity<?> o1,
          ChronoEntity<?> o2)

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

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

minimized

public <T extends ChronoEntity<T>> ChronoOperator<T> minimized(Class<T> context)

Yields a new operator which can set any entity to its minimum element value.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

operator

maximized

public <T extends ChronoEntity<T>> ChronoOperator<T> maximized(Class<T> context)

Yields a new operator which can set any entity to its maximum element value.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

operator

decremented

public <T extends ChronoEntity<T>> ChronoOperator<T> decremented(Class<T> context)

Yields a new operator which can set any entity such that its actual element value gets the decremented value.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

decrementing operator

See Also:

TimeAxis.getBaseUnit(ChronoElement)

incremented

public <T extends ChronoEntity<T>> ChronoOperator<T> incremented(Class<T> context)

Yields a new operator which can set any entity such that its actual element value gets the incremented value.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

incrementing operator

See Also:

TimeAxis.getBaseUnit(ChronoElement)

atFloor

public <T extends ChronoEntity<T>> ChronoOperator<T> atFloor(Class<T> context)

Yields an operator which rounds any entity down so that the child elements will be set to the minimum.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

operator

atCeiling

public <T extends ChronoEntity<T>> ChronoOperator<T> atCeiling(Class<T> context)

Yields an operator which rounds any entity up so that the child elements will be set to the maximum.

Type Parameters:

T - generic type of target entity

Parameters:

context - context type

Returns:

operator

setLenient

public <T extends ChronoEntity<T>> ChronoOperator<T> setLenient(V value,
                                                       Class<T> context)

Yields an operator which sets any entity such that its actual element value will be set in lenient mode to given value.

Type Parameters:

T - generic type of target entity

Parameters:

value - new element value

context - context type

Returns:

operator