org.apache.maven.doxia.sink

Interface Locator

All Known Implementing Classes:

EmptyLocator

public interface Locator

Interface for associating a Sink event with a document location.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
int	getColumnNumber() Returns the column number for the sink event (starting from 1).
int	getLineNumber() Returns the line number for the sink event (starting from 1).
String	getReference() Returns the underlying source reference (for file based documents a relative file path, otherwise an arbitrary string or null).

Method Detail

getReference

String getReference()

Returns the underlying source reference (for file based documents a relative file path, otherwise an arbitrary string or null).

Returns:

the source for the sink event (may be null)

getLineNumber

int getLineNumber()

Returns the line number for the sink event (starting from 1). If it is not known returns -1.

Returns:

the line number for the sink event

getColumnNumber

int getColumnNumber()

Returns the column number for the sink event (starting from 1). If it is not known returns -1.

Returns:

the column number for the sink event