Class AbstractLocator

java.lang.Object

org.apache.maven.doxia.sink.impl.AbstractLocator

All Implemented Interfaces:

Locator

Direct Known Subclasses:

AbstractXmlParser.XmlPullParserLocator, AptParser.AptSourceLocator

public abstract class AbstractLocator
extends Object
implements Locator

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	reference

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLocator(String reference)

Method Summary

Modifier and Type	Method	Description
String	getReference()	Returns the underlying source reference (for file based documents a relative file path, otherwise an arbitrary string or null).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Locator

getColumnNumber, getLineNumber

Field Details

reference

private String reference

Constructor Details

AbstractLocator

protected AbstractLocator(String reference)

Method Details

getReference

public String getReference()

Description copied from interface: Locator

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

Specified by:

getReference in interface Locator

Returns:

the source for the sink event (may be null)