Top Description Fields Constructors Methods
com.github.javaparser

public Class Range

extends Object
Class Inheritance
Static Imports
com.github.javaparser.Position.pos

A range of characters in a source file, from "begin" to "end", including the characters at "begin" and "end".

Field Summary

Modifier and TypeField and Description
public final Position
public final Position

Constructor Summary

AccessConstructor and Description
public
Range(Position begin, Position end)

Method Summary

Modifier and TypeMethod and Description
public boolean
contains(Range other)

As strictlyContains, but two exactly matching ranges are also considered contained one in each other.

public boolean
contains(Position position)

As strictlyContains, but a position that matches the begin or the end of this range is also considered contained one in each other.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
isAfter(Position position)

public boolean
isBefore(Position position)

public boolean
overlapsWith(Range other)

Checks whether this Range overlaps with another Range.

public static Range
range(Position begin, Position end)

public static Range
range(int beginLine, int beginColumn, int endLine, int endColumn)

public boolean
strictlyContains(Range other)

Does this strictly contain other?

public boolean
strictlyContains(Position position)

Does this strictly contain position.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Range
public Range
withBeginColumn(int column)

public Range
withBeginLine(int line)

public Range
public Range
withEndColumn(int column)

public Range
withEndLine(int line)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

beginback to summary
public final Position begin
endback to summary
public final Position end

Constructor Detail

Rangeback to summary
public Range(Position begin, Position end)

Method Detail

containsback to summary
public boolean contains(Range other)

As strictlyContains, but two exactly matching ranges are also considered contained one in each other.

containsback to summary
public boolean contains(Position position)

As strictlyContains, but a position that matches the begin or the end of this range is also considered contained one in each other.

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getLineCountback to summary
public int getLineCount()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isAfterback to summary
public boolean isAfter(Position position)
isBeforeback to summary
public boolean isBefore(Position position)
overlapsWithback to summary
public boolean overlapsWith(Range other)

Checks whether this Range overlaps with another Range. If two ranges overlap, this range or the other range strictlyContains the begin or the end of the other range.

rangeback to summary
public static Range range(Position begin, Position end)
rangeback to summary
public static Range range(int beginLine, int beginColumn, int endLine, int endColumn)
strictlyContainsback to summary
public boolean strictlyContains(Range other)

Does this strictly contain other? It means that this has to be larger than other and it has to start before other and end after other.

strictlyContainsback to summary
public boolean strictlyContains(Position position)

Does this strictly contain position. It means that the position is after the begin of this range and before the end of this range.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
withBeginback to summary
public Range withBegin(Position begin)
withBeginColumnback to summary
public Range withBeginColumn(int column)
withBeginLineback to summary
public Range withBeginLine(int line)
withEndback to summary
public Range withEnd(Position end)
withEndColumnback to summary
public Range withEndColumn(int column)
withEndLineback to summary
public Range withEndLine(int line)