Package trade.invision.indicators.indicators.instant

Class TruncateTo

java.lang.Object

trade.invision.indicators.indicators.Indicator<Instant>

trade.invision.indicators.indicators.instant.TruncateTo

public class TruncateTo
extends Indicator<Instant>

TruncateTo is an Instant Indicator to provide truncated Instants. Truncation returns a copy of the original Instant with fields smaller than the given unit set to zero. For example, truncating with the ChronoUnit.MINUTES unit will set the seconds and milliseconds to zero.

Nested Class Summary

Nested classes/interfaces inherited from class trade.invision.indicators.indicators.Indicator

Indicator.CacheSeries

Field Summary

Fields inherited from class trade.invision.indicators.indicators.Indicator

cachedAddCallCount, cachedIndex, cachedValue, cacheSeries, minimumStableIndex, series

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TruncateTo(Indicator<Instant> indicator, ChronoUnit unit, ZoneId zoneId)

Method Summary

Modifier and Type	Method	Description
protected Instant	calculate(long index)	Performs the calculation of this Indicator at the given index.
static TruncateTo	truncateTo(Indicator<Instant> indicator, ChronoUnit unit)	Calls truncateTo(Indicator, ChronoUnit, ZoneId) with zoneId set to ZoneOffset.UTC.
static TruncateTo	truncateTo(Indicator<Instant> indicator, ChronoUnit unit, ZoneId zoneId)	Gets a TruncateTo.

Methods inherited from class trade.invision.indicators.indicators.Indicator

caching, getMinimumStableIndex, getSeries, getValue, isCaching, numOf, numOf, numOf, numOf, numOfEight, numOfFive, numOfFour, numOfHalf, numOfHundred, numOfHundredth, numOfNegativeOne, numOfNine, numOfOne, numOfSeven, numOfSix, numOfTen, numOfTenth, numOfThousand, numOfThousandth, numOfThree, numOfTwo, numOfZero, purgeCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TruncateTo

protected TruncateTo(Indicator<Instant> indicator,
 ChronoUnit unit,
 ZoneId zoneId)

Method Details

truncateTo

public static TruncateTo truncateTo(Indicator<Instant> indicator,
 ChronoUnit unit)

Calls truncateTo(Indicator, ChronoUnit, ZoneId) with zoneId set to ZoneOffset.UTC.

truncateTo

public static TruncateTo truncateTo(Indicator<Instant> indicator,
 ChronoUnit unit,
 ZoneId zoneId)

Gets a TruncateTo.

Parameters:

indicator - the Indicator

unit - the ChronoUnit

zoneId - the ZoneId to perform the operation in

calculate

protected Instant calculate(long index)

Description copied from class: Indicator

Performs the calculation of this Indicator at the given index.

Specified by:

calculate in class Indicator<Instant>

Parameters:

index - the index

Returns:

the result (never null)