Package trade.invision.indicators.series.bar

Class Bar

java.lang.Object

trade.invision.indicators.series.bar.Bar

public final class Bar
extends Object

Bar represents the price data of an instrument within a span of time. A Bar may also be referred to as a "candlestick" or "OHLC" (Open, High, Low, Close).

See Also:

• Investopedia

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Bar.BarBuilder

Constructor Summary

Constructors

Constructor	Description
Bar(Instant start, Duration duration, Num tradePrice, Num tradeVolume)	Instantiates a new Bar.
Bar(Instant start, Duration duration, Num open, Num high, Num low, Num close, Num volume, Num tradeCount)	Instantiates a new Bar.
Bar(Instant start, Instant end, Num open, Num high, Num low, Num close, Num volume, Num tradeCount)	Creates a new Bar instance.

Method Summary

Modifier and Type	Method	Description
Bar	addPrice(Num price)	Calls addTrade(Num, Num) with volume set to null.
Bar	addTrade(Num price, @Nullable Num volume)	Creates a new Bar from this Bar with the new trade data.
Bar	aggregate(Bar bar)	Creates a new Bar by aggregating this Bar and the given Bar.
static Bar.BarBuilder	builder()
boolean	containsInstant(Instant instant)	Checks if the given Instant is contained within getStart() (inclusive) and getEnd() (exclusive).
boolean	equals(Object o)
Num	getClose()
Duration	getDuration()	Gets the Duration (period) of this Bar.
Instant	getEnd()	The end Instant of this Bar (exclusive).
Num	getHigh()
Num	getLow()
Num	getOpen()
Instant	getStart()	The start Instant of this Bar (inclusive).
Num	getTradeCount()
Num	getVolume()
int	hashCode()
boolean	isBearish()	Checks if getClose() is less than getOpen().
boolean	isBullish()	Checks if getClose() is greater than getOpen().
boolean	overlaps(Bar bar)	Checks if the given Bar getStart() (inclusive) is containsInstant(Instant) of this Bar or if the given Bar getEnd() (exclusive) is containsInstant(Instant) of this Bar.
Bar.BarBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Bar

public Bar(Instant start,
 Duration duration,
 Num tradePrice,
 Num tradeVolume)

Instantiates a new Bar.

Parameters:

start - the start Instant

duration - the Duration

tradePrice - the trade price Num

tradeVolume - the trade volume Num

Bar

public Bar(Instant start,
 Duration duration,
 Num open,
 Num high,
 Num low,
 Num close,
 Num volume,
 Num tradeCount)

Instantiates a new Bar.

Parameters:

start - the start Instant

duration - the Duration

open - the open Num

high - the high Num

low - the low Num

close - the close Num

volume - the volume Num

tradeCount - the trade count Num

Bar

public Bar(Instant start,
 Instant end,
 Num open,
 Num high,
 Num low,
 Num close,
 Num volume,
 Num tradeCount)

Creates a new Bar instance.

Parameters:

start - The start Instant of this Bar (inclusive).

end - The end Instant of this Bar (exclusive).

open -

high -

low -

close -

volume -

tradeCount -

Method Details

getDuration

public Duration getDuration()

Gets the Duration (period) of this Bar.

Returns:

the Duration

See Also:

• Duration.between(Temporal, Temporal)
• getStart()
• getEnd()

addPrice

public Bar addPrice(Num price)

Calls addTrade(Num, Num) with volume set to null.

addTrade

public Bar addTrade(Num price,
 @Nullable
 @Nullable Num volume)

Creates a new Bar from this Bar with the new trade data.

Parameters:

price - the price Num

volume - the volume Num, or null to not update getVolume()

Returns:

the new Bar

aggregate

public Bar aggregate(Bar bar)

Creates a new Bar by aggregating this Bar and the given Bar.

Parameters:

bar - the Bar

Returns:

the new Bar

containsInstant

public boolean containsInstant(Instant instant)

Checks if the given Instant is contained within getStart() (inclusive) and getEnd() (exclusive).

Parameters:

instant - the Instant

Returns:

true if contained, false otherwise

overlaps

public boolean overlaps(Bar bar)

Checks if the given Bar getStart() (inclusive) is containsInstant(Instant) of this Bar or if the given Bar getEnd() (exclusive) is containsInstant(Instant) of this Bar.

Parameters:

bar - a Bar

Returns:

true if overlaps, false otherwise

isBullish

public boolean isBullish()

Checks if getClose() is greater than getOpen().

Returns:

true if bullish, false otherwise

isBearish

public boolean isBearish()

Checks if getClose() is less than getOpen().

Returns:

true if bearish, false otherwise

builder

public static Bar.BarBuilder builder()

toBuilder

public Bar.BarBuilder toBuilder()

getStart

public Instant getStart()

The start Instant of this Bar (inclusive).

getEnd

public Instant getEnd()

The end Instant of this Bar (exclusive).

getOpen

public Num getOpen()

getHigh

public Num getHigh()

getLow

public Num getLow()

getClose

public Num getClose()

getVolume

public Num getVolume()

getTradeCount

public Num getTradeCount()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object