CodeSnipitLocation (JavaForger 2.0.0 API)

java.lang.Object
- merger.CodeSnipitLocation

All Implemented Interfaces:

Comparable<CodeSnipitLocation>
```
public class CodeSnipitLocation
extends Object
implements Comparable<CodeSnipitLocation>
```
Defines the location of a code block with an inclusive start line number and an exclusive end line number.

Author:

Daan

Constructor Summary

Constructors
Constructor and Description

CodeSnipitLocation(int start, int end)

Constructors
Constructor and Description
`CodeSnipitLocation(int start, int end)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CodeSnipitLocation`	`after(com.github.javaparser.ast.Node node)` Creates a new `CodeSnipitLocation` representing the line directly below the given `JavaParser` `Node`.
`static CodeSnipitLocation`	`before(com.github.javaparser.ast.Node node)` Creates a new `CodeSnipitLocation` representing the line directly above the given `JavaParser` `Node`.
`int`	`compareTo(CodeSnipitLocation that)`
`boolean`	`containsLines()`
`boolean`	`equals(Object obj)`
`int`	`getEnd()`
`int`	`getFirstIndex()`
`int`	`getLastIndex()`
`int`	`getStart()`
`int`	`hashCode()`
`static CodeSnipitLocation`	`of(int startEnd)` Creates a new `CodeSnipitLocation` of a single line.
`static CodeSnipitLocation`	`of(int start, int end)` Creates a new `CodeSnipitLocation`.
`static CodeSnipitLocation`	`of(com.github.javaparser.ast.Node node)` Creates a new `CodeSnipitLocation` for the given `Node`.
`int`	`size()`
`String`	`toString()`

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

- Constructor Detail
  - CodeSnipitLocation
```
public CodeSnipitLocation(int start,
                          int end)
```
    Parameters:
    
    start - start
    
    end - end
- Method Detail
  - getStart
```
public int getStart()
```
    See Also:
    
    start
  - getEnd
```
public int getEnd()
```
    See Also:
    
    end
  - getFirstIndex
```
public int getFirstIndex()
```
    Returns:
    
    the start line number minus one. Mend to be used in combination with arrays of strings.
  - getLastIndex
```
public int getLastIndex()
```
    Returns:
    
    the end line number minus one. Mend to be used in combination with arrays of strings.
  - containsLines
```
public boolean containsLines()
```
    Returns:
    
    true if the end line is higher than the start line, false otherwise.
  - size
```
public int size()
```
    Returns:
    
    The total number of lines represented by this CodeSnipitLocation.
  - of
```
public static CodeSnipitLocation of(int start,
                                    int end)
```
    Creates a new CodeSnipitLocation.
    
    Parameters:
    
    start - The start
    
    end - The end
    
    Returns:
    
    new CodeSnipitLocation
  - of
```
public static CodeSnipitLocation of(int startEnd)
```
    Creates a new CodeSnipitLocation of a single line.
    
    Parameters:
    
    startEnd - The start and end
    
    Returns:
    
    new CodeSnipitLocation
  - of
```
public static CodeSnipitLocation of(com.github.javaparser.ast.Node node)
```
    Creates a new CodeSnipitLocation for the given Node.
    
    Parameters:
    
    node - The JavaParser Node used to determine the beginning and end of the node. Javadoc is not taken into account.
    
    Returns:
    
    new CodeSnipitLocation.
  - before
```
public static CodeSnipitLocation before(com.github.javaparser.ast.Node node)
```
    Creates a new CodeSnipitLocation representing the line directly above the given JavaParser Node.
    
    Parameters:
    
    node - the JavaParser Node.
    
    Returns:
    
    a new CodeSnipitLocation.
  - after
```
public static CodeSnipitLocation after(com.github.javaparser.ast.Node node)
```
    Creates a new CodeSnipitLocation representing the line directly below the given JavaParser Node.
    
    Parameters:
    
    node - the JavaParser Node.
    
    Returns:
    
    a new CodeSnipitLocation.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(CodeSnipitLocation that)
```
    Specified by:
    
    compareTo in interface Comparable<CodeSnipitLocation>

Class CodeSnipitLocation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodeSnipitLocation

Method Detail

getStart

getEnd

getFirstIndex

getLastIndex

containsLines

size

of

of

of

before

after

hashCode

equals

toString

compareTo