LineBreakLookback (JForex API 2.12.46 API)

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

All Implemented Interfaces:

Comparable<LineBreakLookback>
```
public class LineBreakLookback
extends Object
implements Comparable<LineBreakLookback>
```
This class is used for Line Break data look-back identification. E.g. 3 Line Break, 4 Line Break, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static LineBreakLookback`	`FIVE_LINES`
`static LineBreakLookback`	`FOUR_LINES`
`static int`	`MAX_NUM_OF_LINES`
`static int`	`MIN_NUM_OF_LINES`
`static LineBreakLookback`	`THREE_LINES`
`static LineBreakLookback`	`TWO_LINES`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(LineBreakLookback lookback)` The method compares passed LineBreakLookback with the current one if (lookback == null) or (lookback.getNumOfLines() < this.getNumOfLines()) Returns 1 if lookback.getNumOfLines() > this.getNumOfLines() Returns -1 Otherwise Returns 0
`static LineBreakLookback[]`	`createAllPossibleNLineBreakLookbackValues()` Method creates and returns all available LineBreakLookback's
`boolean`	`equals(Object obj)`
`static LineBreakLookback`	`getDefault()`
`String`	`getName()` Method returns the name of look-back value
`int`	`getNumOfLines()` Method returns number of look-back lines
`int`	`hashCode()`
`String`	`toString()`
`static LineBreakLookback`	`valueOf(int lineNum)` The method returns appropriate LineBreakLookback for the passed number of lines.
`static LineBreakLookback`	`valueOf(String str)` The method returns appropriate LineBreakLookback for the passed String Note - maximal allowed number of look-back lines is 10, minimal - 2.

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

- Field Detail
  - TWO_LINES
```
public static final LineBreakLookback TWO_LINES
```
  - THREE_LINES
```
public static final LineBreakLookback THREE_LINES
```
  - FOUR_LINES
```
public static final LineBreakLookback FOUR_LINES
```
  - FIVE_LINES
```
public static final LineBreakLookback FIVE_LINES
```
  - MIN_NUM_OF_LINES
```
public static int MIN_NUM_OF_LINES
```
  - MAX_NUM_OF_LINES
```
public static int MAX_NUM_OF_LINES
```
- Method Detail
  - getName
```
public String getName()
```
    Method returns the name of look-back value
    
    Returns:
    the name of look-back value
  - getNumOfLines
```
public int getNumOfLines()
```
    Method returns number of look-back lines
    
    Returns:
    number of look-back lines
  - valueOf
```
public static LineBreakLookback valueOf(String str)
```
    The method returns appropriate LineBreakLookback for the passed String Note - maximal allowed number of look-back lines is 10, minimal - 2.
    
    Parameters:
    str - String representation
    
    Returns:
    LineBreakLookback
  - valueOf
```
public static LineBreakLookback valueOf(int lineNum)
```
    The method returns appropriate LineBreakLookback for the passed number of lines. Note - maximal allowed number of look-back lines is 10, minimal - 2.
    
    Parameters:
    lineNum -
    
    Returns:
    LineBreakLookback or null, if the lineNum exceeds allowed values.
  - getDefault
```
public static LineBreakLookback getDefault()
```
  - createAllPossibleNLineBreakLookbackValues
```
public static LineBreakLookback[] createAllPossibleNLineBreakLookbackValues()
```
    Method creates and returns all available LineBreakLookback's
    
    Returns:
    the list of LineBreakLookback
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(LineBreakLookback lookback)
```
    The method compares passed LineBreakLookback with the current one if (lookback == null) or (lookback.getNumOfLines() < this.getNumOfLines()) Returns 1 if lookback.getNumOfLines() > this.getNumOfLines() Returns -1 Otherwise Returns 0
    
    Specified by:
    
    compareTo in interface Comparable<LineBreakLookback>
    
    Parameters:
    lookback - LineBreakLookback 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 LineBreakLookback

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TWO_LINES

THREE_LINES

FOUR_LINES

FIVE_LINES

MIN_NUM_OF_LINES

MAX_NUM_OF_LINES

Method Detail

getName

getNumOfLines

valueOf

valueOf

getDefault

createAllPossibleNLineBreakLookbackValues

toString

compareTo

hashCode

equals