ReversalAmount (JForex API 2.12.46 API)

java.lang.Object
- com.dukascopy.api.ReversalAmount

All Implemented Interfaces:

Comparable<ReversalAmount>
```
public final class ReversalAmount
extends Object
implements Comparable<ReversalAmount>
```
The class indicates the amount of price movement required to shift a chart to the right. This condition is used on charts that only take into consideration price movement instead of both price and time. Is used for Point and Figures charts for example.

Author:

marks.vilkelis

Field Summary

Fields
Modifier and Type	Field and Description
`static ReversalAmount`	`FIVE`
`static ReversalAmount`	`FOUR`
`static int`	`MAXIMAL_REVERSAL_AMOUNT`
`static ReversalAmount`	`ONE`
`static ReversalAmount`	`THREE`
`static ReversalAmount`	`TWO`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(ReversalAmount reversalAmount)` The method compares passed ReversalAmount with the current one if (ReversalAmount == null) or (ReversalAmount.getAmount() < this.getAmount()) Returns 1 if ReversalAmount.getAmount() > this.getAmount() Returns -1 Otherwise Returns 0
`static List<ReversalAmount>`	`createJForexPriceRanges()` Method creates and returns all available to JForex Reversal Amounts
`boolean`	`equals(Object obj)`
`int`	`getAmount()`
`int`	`hashCode()`
`String`	`toString()`
`static ReversalAmount`	`valueOf(int amount)` The method returns appropriate Reversal Amount for the passed amount
`static ReversalAmount`	`valueOf(String str)` The method returns appropriate ReversalAmount for the passed String

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ONE
```
public static final ReversalAmount ONE
```
  - TWO
```
public static final ReversalAmount TWO
```
  - THREE
```
public static final ReversalAmount THREE
```
  - FOUR
```
public static final ReversalAmount FOUR
```
  - FIVE
```
public static final ReversalAmount FIVE
```
  - MAXIMAL_REVERSAL_AMOUNT
```
public static int MAXIMAL_REVERSAL_AMOUNT
```
- Method Detail
  - valueOf
```
public static ReversalAmount valueOf(String str)
```
    The method returns appropriate ReversalAmount for the passed String
    
    Parameters:
    str - String representation
    
    Returns:
    Reversal Amount
  - valueOf
```
public static ReversalAmount valueOf(int amount)
```
    The method returns appropriate Reversal Amount for the passed amount
    
    Parameters:
    amount - int to parse to ReversalAmount
    
    Returns:
    Reversal Amount
  - createJForexPriceRanges
```
public static List<ReversalAmount> createJForexPriceRanges()
```
    Method creates and returns all available to JForex Reversal Amounts
    
    Returns:
    the list of Reversal Amounts
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAmount
```
public int getAmount()
```
  - compareTo
```
public int compareTo(ReversalAmount reversalAmount)
```
    The method compares passed ReversalAmount with the current one if (ReversalAmount == null) or (ReversalAmount.getAmount() < this.getAmount()) Returns 1 if ReversalAmount.getAmount() > this.getAmount() Returns -1 Otherwise Returns 0
    
    Specified by:
    
    compareTo in interface Comparable<ReversalAmount>
    
    Parameters:
    reversalAmount - ReversalAmount object to compare
    
    Returns:
    comparison result
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ReversalAmount

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE

TWO

THREE

FOUR

FIVE

MAXIMAL_REVERSAL_AMOUNT

Method Detail

valueOf

valueOf

createJForexPriceRanges

toString

getAmount

compareTo

hashCode

equals