org.jsoup.nodes.Range Maven / Gradle / Ivy
package org.jsoup.nodes;
import static org.jsoup.internal.SharedConstants.*;
/**
A Range object tracks the character positions in the original input source where a Node starts or ends. If you want to
track these positions, tracking must be enabled in the Parser with
{@link org.jsoup.parser.Parser#setTrackPosition(boolean)}.
@see Node#sourceRange()
@since 1.15.2
*/
public class Range {
private static final Position UntrackedPos = new Position(-1, -1, -1);
private final Position start, end;
/** An untracked source range. */
static final Range Untracked = new Range(UntrackedPos, UntrackedPos);
/**
Creates a new Range with start and end Positions. Called by TreeBuilder when position tracking is on.
* @param start the start position
* @param end the end position
*/
public Range(Position start, Position end) {
this.start = start;
this.end = end;
}
/**
Get the start position of this node.
* @return the start position
*/
public Position start() {
return start;
}
/**
Get the starting cursor position of this range.
@return the 0-based start cursor position.
@since 1.17.1
*/
public int startPos() {
return start.pos;
}
/**
Get the end position of this node.
* @return the end position
*/
public Position end() {
return end;
}
/**
Get the ending cursor position of this range.
@return the 0-based ending cursor position.
@since 1.17.1
*/
public int endPos() {
return end.pos;
}
/**
Test if this source range was tracked during parsing.
* @return true if this was tracked during parsing, false otherwise (and all fields will be {@code -1}).
*/
public boolean isTracked() {
return this != Untracked;
}
/**
Checks if the range represents a node that was implicitly created / closed.
For example, with HTML of {@code
One
Two}, both {@code p} elements will have an explicit
{@link Element#sourceRange()} but an implicit {@link Element#endSourceRange()} marking the end position, as neither
have closing {@code
} tags. The TextNodes will have explicit sourceRanges.
A range is considered implicit if its start and end positions are the same.
@return true if the range is tracked and its start and end positions are the same, false otherwise.
@since 1.17.1
*/
public boolean isImplicit() {
if (!isTracked()) return false;
return start.equals(end);
}
/**
Retrieves the source range for a given Node.
* @param node the node to retrieve the position for
* @param start if this is the starting range. {@code false} for Element end tags.
* @return the Range, or the Untracked (-1) position if tracking is disabled.
*/
static Range of(Node node, boolean start) {
final String key = start ? RangeKey : EndRangeKey;
if (!node.hasAttributes()) return Untracked;
Object range = node.attributes().userData(key);
return range != null ? (Range) range : Untracked;
}
/**
@deprecated no-op; internal method moved out of visibility
*/
@Deprecated
public void track(Node node, boolean start) {}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Range range = (Range) o;
if (!start.equals(range.start)) return false;
return end.equals(range.end);
}
@Override
public int hashCode() {
int result = start.hashCode();
result = 31 * result + end.hashCode();
return result;
}
/**
Gets a String presentation of this Range, in the format {@code line,column:pos-line,column:pos}.
* @return a String
*/
@Override
public String toString() {
return start + "-" + end;
}
/**
A Position object tracks the character position in the original input source where a Node starts or ends. If you want to
track these positions, tracking must be enabled in the Parser with
{@link org.jsoup.parser.Parser#setTrackPosition(boolean)}.
@see Node#sourceRange()
*/
public static class Position {
private final int pos, lineNumber, columnNumber;
/**
Create a new Position object. Called by the TreeBuilder if source position tracking is on.
* @param pos position index
* @param lineNumber line number
* @param columnNumber column number
*/
public Position(int pos, int lineNumber, int columnNumber) {
this.pos = pos;
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
}
/**
Gets the position index (0-based) of the original input source that this Position was read at. This tracks the
total number of characters read into the source at this position, regardless of the number of preceding lines.
* @return the position, or {@code -1} if untracked.
*/
public int pos() {
return pos;
}
/**
Gets the line number (1-based) of the original input source that this Position was read at.
* @return the line number, or {@code -1} if untracked.
*/
public int lineNumber() {
return lineNumber;
}
/**
Gets the cursor number (1-based) of the original input source that this Position was read at. The cursor number
resets to 1 on every new line.
* @return the cursor number, or {@code -1} if untracked.
*/
public int columnNumber() {
return columnNumber;
}
/**
Test if this position was tracked during parsing.
* @return true if this was tracked during parsing, false otherwise (and all fields will be {@code -1}).
*/
public boolean isTracked() {
return this != UntrackedPos;
}
/**
Gets a String presentation of this Position, in the format {@code line,column:pos}.
* @return a String
*/
@Override
public String toString() {
return lineNumber + "," + columnNumber + ":" + pos;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Position position = (Position) o;
if (pos != position.pos) return false;
if (lineNumber != position.lineNumber) return false;
return columnNumber == position.columnNumber;
}
@Override
public int hashCode() {
int result = pos;
result = 31 * result + lineNumber;
result = 31 * result + columnNumber;
return result;
}
}
public static class AttributeRange {
static final AttributeRange UntrackedAttr = new AttributeRange(Range.Untracked, Range.Untracked);
private final Range nameRange;
private final Range valueRange;
/** Creates a new AttributeRange. Called during parsing by Token.StartTag. */
public AttributeRange(Range nameRange, Range valueRange) {
this.nameRange = nameRange;
this.valueRange = valueRange;
}
/** Get the source range for the attribute's name. */
public Range nameRange() {
return nameRange;
}
/** Get the source range for the attribute's value. */
public Range valueRange() {
return valueRange;
}
/** Get a String presentation of this Attribute range, in the form
{@code line,column:pos-line,column:pos=line,column:pos-line,column:pos} (name start - name end = val start - val end).
. */
@Override public String toString() {
return nameRange().toString() + "=" + valueRange().toString();
}
@Override public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
AttributeRange that = (AttributeRange) o;
if (!nameRange.equals(that.nameRange)) return false;
return valueRange.equals(that.valueRange);
}
@Override public int hashCode() {
int result = nameRange.hashCode();
result = 31 * result + valueRange.hashCode();
return result;
}
}
}