Ion Java 1.11.10 · com.amazon.ion.TextSpan · APIdia, the JavaDoc alternative

Exposes the positions of a Span in the form of one-based line and column numbers within the source text stream.

Warning

This interface should not be implemented or extended by code outside of this library.

As with all spans, positions lie between values, and when the start and finish positions are equal, the span is said to be empty.

To get one of these from a Span, use asFacet(TextSpan.class) or one of the helpers from Spans.

Method Summary

Modifier and Type	Method and Description
public long	getFinishColumn() Returns the column number of this span's finish position, counting from one.
public long	getFinishLine() Returns the line number of this span's finish position, counting from one.
public long	getStartColumn() Returns the column number of this span's start position, counting from one.
public long	getStartLine() Returns the line number of this span's start position, counting from one.

getFinishColumn	back to summary
public long getFinishColumn() Returns the column number of this span's finish position, counting from one. In most cases, the finish position is implicit and this method returns `-1`. That's since in general (notably for containers) the finish offset can't be determined without significant effort to parse to the end of the value.

getFinishLine	back to summary
public long getFinishLine() Returns the line number of this span's finish position, counting from one. In most cases, the finish position is implicit and this method returns `-1`. That's since in general (notably for containers) the finish offset can't be determined without significant effort to parse to the end of the value.

getStartColumn	back to summary
public long getStartColumn() Returns the column number of this span's start position, counting from one.

getStartLine	back to summary
public long getStartLine() Returns the line number of this span's start position, counting from one.