com.oanda.fxtrade.api
Interface FXTick

All Superinterfaces:

java.lang.Cloneable

public interface FXTick
extends java.lang.Cloneable

An FXTick object represents a single forex spot price.

clone

java.lang.Object clone()

Returns a exact copy of this FXTick.

equals

boolean equals(java.lang.Object o)

Compares two FXTick objects.

Overrides:

equals in class java.lang.Object

Parameters:

o - the FXTick to be compared

Returns:

true if the timestamp, bid and ask are exactly equal, false otherwise

getPair

FXPair getPair()

getAsk

double getAsk()

Returns the ask price.

Returns:

the ask price

getBid

double getBid()

Returns the bid price.

Returns:

the bid price

getInverse

FXTick getInverse()

Return a new FXTick which is the inverse of this FXTick.

Note: bid = 1 / ask ; ask = 1 / bid

Returns:

a new FXTick which is the inverse of this FXTick.

getMean

double getMean()

getTimestamp

long getTimestamp()

Returns the unix timestamp for this FXTick.

Returns:

the unix timestamp for this FXTick.

hashCode

int hashCode()

Return the hashcode of this pair

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode of this pair

setAsk

void setAsk(double ask)

Sets the ask price. TODO remove this method when implementation staged

Parameters:

ask - the ask price

setBid

void setBid(double bid)

Sets the bid price. TODO remove this method when implementation staged

Parameters:

bid - the bid price

setTimestamp

void setTimestamp(long timestamp)

Sets the timestamp. TODO remove this method when implementation staged

Parameters:

timestamp - the timestamp

getMaxUnits

long getMaxUnits()

Returns the maximum amount of units this tick applies for.

Returns:

the maximum amount of units this tick applies for

setMaxUnits

void setMaxUnits(long maxUnits)

Sets the max units this tick is valid for.

Parameters:

maxUnits - max units this tick is valid for

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object