net.time4j

Interface AdjustableElement<V,T>

Type Parameters:

V - generic type of element values

T - generic type of target entity an operator is applied to

All Superinterfaces:

ChronoElement<V>, Comparator<ChronoDisplay>, ZonalElement<V>

All Known Subinterfaces:

NavigableElement<V>, OrdinalWeekdayElement, ProportionalElement<V,T>

public interface AdjustableElement<V,T>
extends ZonalElement<V>

Extends a chronological element by some standard ways of manipulation.

Author:

Meno Hochschild

Method Summary

Modifier and Type	Method and Description
ElementOperator<T>	atCeiling() Rounds up an entity by setting all child elements to maximum.
ElementOperator<T>	atFloor() Rounds down an entity by setting all child elements to minimum.
ElementOperator<T>	decremented() Adjusts any local entity such that this element gets the previous value.
ElementOperator<T>	incremented() Adjusts any local entity such that this element gets the next value.
ElementOperator<T>	maximized() Sets any local entity to the maximum of this element.
ElementOperator<T>	minimized() Sets any local entity to the minimum of this element.
ElementOperator<T>	newValue(V value) Sets any local entity to given new value of this element.

Methods inherited from interface net.time4j.ZonalElement

at, atUTC, in, inStdTimezone, inTimezone

Methods inherited from interface net.time4j.engine.ChronoElement

compare, getDefaultMaximum, getDefaultMinimum, getSymbol, getType, isDateElement, isLenient, isTimeElement, 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

Method Detail

newValue

ElementOperator<T> newValue(V value)

Sets any local entity to given new value of this element.

Parameters:

value - new element value

Returns:

operator directly applicable also on PlainTimestamp

Since:

2.0

See Also:

ChronoEntity.with(ChronoElement, V)

minimized

ElementOperator<T> minimized()

Sets any local entity to the minimum of this element.

Returns:

operator directly applicable also on PlainTimestamp

maximized

ElementOperator<T> maximized()

Sets any local entity to the maximum of this element.

Returns:

operator directly applicable also on PlainTimestamp

decremented

ElementOperator<T> decremented()

Adjusts any local entity such that this element gets the previous value.

The operator throws a ChronoException if there is no base unit available for this element.

Returns:

operator directly applicable also on PlainTimestamp and requiring a base unit in given chronology for decrementing

See Also:

TimeAxis.getBaseUnit(ChronoElement)

incremented

ElementOperator<T> incremented()

Adjusts any local entity such that this element gets the next value.

The operator throws a ChronoException if there is no base unit available for this element.

Returns:

operator directly applicable also on PlainTimestamp and requiring a base unit in given chronology for incrementing

See Also:

TimeAxis.getBaseUnit(ChronoElement)

atFloor

ElementOperator<T> atFloor()

Rounds down an entity by setting all child elements to minimum.

Returns:

operator directly applicable on local types without timezone

atCeiling

ElementOperator<T> atCeiling()

Rounds up an entity by setting all child elements to maximum.

Returns:

operator directly applicable on local types without timezone