Package org.opengrok.indexer.analysis

Class TextMatchedEvent

java.lang.Object

org.opengrok.indexer.analysis.TextMatchedEvent

public class TextMatchedEvent
extends Object

Represents an event raised when a symbol matcher matches a string that would not be published as a symbol.

Constructor Summary

Constructors

Constructor	Description
TextMatchedEvent(Object source, String str, long start, long end)	Initializes an immutable instance of TextMatchedEvent.
TextMatchedEvent(Object source, String str, EmphasisHint hint, long start, long end)	Initializes an immutable instance of TextMatchedEvent.

Method Summary

Modifier and Type	Method	Description
long	getEnd()	Gets the text end position.
EmphasisHint	getHint()	Gets the text hint.
Object	getSource()	Gets the event source.
long	getStart()	Gets the text start position.
String	getStr()	Gets the text string.

Methods inherited from class java.lang.Object

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

Constructor Details

TextMatchedEvent

public TextMatchedEvent(Object source,
 String str,
 long start,
 long end)

Initializes an immutable instance of TextMatchedEvent.

Parameters:

source - the event source

str - the text string

start - the text start position

end - the text end position

TextMatchedEvent

public TextMatchedEvent(Object source,
 String str,
 EmphasisHint hint,
 long start,
 long end)

Initializes an immutable instance of TextMatchedEvent.

Parameters:

source - the event source

str - the text string

hint - the text hint

start - the text start position

end - the text end position

Method Details

getSource

public Object getSource()

Gets the event source.

Returns:

the initial value

getStr

public String getStr()

Gets the text string.

Returns:

the initial value

getStart

public long getStart()

Gets the text start position.

Returns:

the initial value

getEnd

public long getEnd()

Gets the text end position.

Returns:

the initial value

getHint

public EmphasisHint getHint()

Gets the text hint.

Returns:

the initial value