PriceRange (JForex API 2.12.46 API)

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

All Implemented Interfaces:

Comparable<PriceRange>
```
public final class PriceRange
extends Object
implements Comparable<PriceRange>
```
The class is used for Range Bar and Point&Figures price interval in pips identification

Author:

Mark Vilkel

Field Summary

Fields
Modifier and Type	Field and Description
`static PriceRange`	`FIVE_PIPS`
`static PriceRange`	`FOUR_PIPS`
`static int`	`MAXIMAL_PIP_COUNT`
`static PriceRange`	`ONE_PIP`
`static PriceRange`	`SIX_PIPS`
`static PriceRange`	`THREE_PIPS`
`static PriceRange`	`TWO_PIPS`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(PriceRange priceRange)` The method compares passed PriceRange with the current one if (PriceRange == null) or (PriceRange.getPipCount() < this.getPipCount()) Returns 1 if PriceRange.getPipCount() > this.getPipCount() Returns -1 Otherwise Returns 0
`static List<PriceRange>`	`createJForexPriceRanges()` Method creates and returns all available to JForex Price Ranges.
`boolean`	`equals(Object obj)`
`String`	`getName()` Method returns the price range name
`int`	`getPipCount()` Method returns pip count of price range
`int`	`hashCode()`
`String`	`toString()`
`static PriceRange`	`valueOf(int pipCount)` The method returns appropriate PriceRange for the passed pip count
`static PriceRange`	`valueOf(String str)` The method returns appropriate PriceRange for the passed String

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

- Field Detail
  - ONE_PIP
```
public static final PriceRange ONE_PIP
```
  - TWO_PIPS
```
public static final PriceRange TWO_PIPS
```
  - THREE_PIPS
```
public static final PriceRange THREE_PIPS
```
  - FOUR_PIPS
```
public static final PriceRange FOUR_PIPS
```
  - FIVE_PIPS
```
public static final PriceRange FIVE_PIPS
```
  - SIX_PIPS
```
public static final PriceRange SIX_PIPS
```
  - MAXIMAL_PIP_COUNT
```
public static int MAXIMAL_PIP_COUNT
```
- Method Detail
  - getName
```
public String getName()
```
    Method returns the price range name
    
    Returns:
    the name of price range
  - getPipCount
```
public int getPipCount()
```
    Method returns pip count of price range
    
    Returns:
    pip count
  - valueOf
```
public static PriceRange valueOf(String str)
```
    The method returns appropriate PriceRange for the passed String
    
    Parameters:
    str - String representation
    
    Returns:
    price range
  - valueOf
```
public static PriceRange valueOf(int pipCount)
```
    The method returns appropriate PriceRange for the passed pip count
    
    Parameters:
    pipCount - pip count value
    
    Returns:
    price range
  - createJForexPriceRanges
```
public static List<PriceRange> createJForexPriceRanges()
```
    Method creates and returns all available to JForex Price Ranges.
    
    Returns:
    the list of price ranges
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(PriceRange priceRange)
```
    The method compares passed PriceRange with the current one if (PriceRange == null) or (PriceRange.getPipCount() < this.getPipCount()) Returns 1 if PriceRange.getPipCount() > this.getPipCount() Returns -1 Otherwise Returns 0
    
    Specified by:
    
    compareTo in interface Comparable<PriceRange>
    
    Parameters:
    priceRange - PriceRange 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 PriceRange

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_PIP

TWO_PIPS

THREE_PIPS

FOUR_PIPS

FIVE_PIPS

SIX_PIPS

MAXIMAL_PIP_COUNT

Method Detail

getName

getPipCount

valueOf

valueOf

createJForexPriceRanges

toString

compareTo

hashCode

equals