org.ta4j.core

Interface Bar

All Superinterfaces:

Serializable

All Known Implementing Classes:

BaseBar

public interface Bar
extends Serializable

End bar of a time period. Bar object is aggregated open/high/low/close/volume/etc. data over a time period.

Method Summary

Modifier and Type	Method and Description
void	addPrice(Num price)
default void	addPrice(Number price, java.util.function.Function<Number,Num> numFunction)
default void	addPrice(String price, java.util.function.Function<Number,Num> numFunction)
default void	addTrade(double tradeVolume, double tradePrice, java.util.function.Function<Number,Num> numFunction) Deprecated. use corresponding function of BarSeries
void	addTrade(Num tradeVolume, Num tradePrice) Adds a trade at the end of bar period.
default void	addTrade(String tradeVolume, String tradePrice, java.util.function.Function<Number,Num> numFunction) Deprecated. use corresponding function of BarSeries
Num	getAmount()
java.time.ZonedDateTime	getBeginTime()
Num	getClosePrice()
default String	getDateName()
java.time.ZonedDateTime	getEndTime()
Num	getHighPrice()
Num	getLowPrice()
Num	getOpenPrice()
default String	getSimpleDateName()
java.time.Duration	getTimePeriod()
int	getTrades()
Num	getVolume()
default boolean	inPeriod(java.time.ZonedDateTime timestamp)
default boolean	isBearish()
default boolean	isBullish()

Method Detail

getOpenPrice

Num getOpenPrice()

Returns:

the open price of the period

getLowPrice

Num getLowPrice()

Returns:

the low price of the period

getHighPrice

Num getHighPrice()

Returns:

the high price of the period

getClosePrice

Num getClosePrice()

Returns:

the close price of the period

getVolume

Num getVolume()

Returns:

the whole tradeNum volume in the period

getTrades

int getTrades()

Returns:

the number of trades in the period

getAmount

Num getAmount()

Returns:

the whole traded amount of the period

getTimePeriod

java.time.Duration getTimePeriod()

Returns:

the time period of the bar

getBeginTime

java.time.ZonedDateTime getBeginTime()

Returns:

the begin timestamp of the bar period

getEndTime

java.time.ZonedDateTime getEndTime()

Returns:

the end timestamp of the bar period

inPeriod

default boolean inPeriod(java.time.ZonedDateTime timestamp)

Parameters:

timestamp - a timestamp

Returns:

true if the provided timestamp is between the begin time and the end time of the current period, false otherwise

getDateName

default String getDateName()

Returns:

a human-friendly string of the end timestamp

getSimpleDateName

default String getSimpleDateName()

Returns:

a even more human-friendly string of the end timestamp

isBearish

default boolean isBearish()

Returns:

true if this is a bearish bar, false otherwise

isBullish

default boolean isBullish()

Returns:

true if this is a bullish bar, false otherwise

addTrade

@Deprecated
default void addTrade(double tradeVolume,
                                   double tradePrice,
                                   java.util.function.Function<Number,Num> numFunction)

Deprecated. use corresponding function of BarSeries

Adds a trade at the end of bar period.

Parameters:

tradeVolume - the traded volume

tradePrice - the price

addTrade

@Deprecated
default void addTrade(String tradeVolume,
                                   String tradePrice,
                                   java.util.function.Function<Number,Num> numFunction)

Deprecated. use corresponding function of BarSeries

Adds a trade at the end of bar period.

Parameters:

tradeVolume - the traded volume

tradePrice - the price

addTrade

void addTrade(Num tradeVolume,
              Num tradePrice)

Adds a trade at the end of bar period.

Parameters:

tradeVolume - the traded volume

tradePrice - the price

addPrice

default void addPrice(String price,
                      java.util.function.Function<Number,Num> numFunction)

addPrice

default void addPrice(Number price,
                      java.util.function.Function<Number,Num> numFunction)

addPrice

void addPrice(Num price)