Package com.norconex.crawler.core.event

Class CrawlerEvent.CrawlerEventBuilder<C extends CrawlerEvent,B extends CrawlerEvent.CrawlerEventBuilder<C,B>>

java.lang.Object

com.norconex.commons.lang.event.EventObjectAdapter.EventObjectAdapterBuilder<C,B>

com.norconex.commons.lang.event.Event.EventBuilder<C,B>

com.norconex.crawler.core.event.CrawlerEvent.CrawlerEventBuilder<C,B>

Enclosing class:

CrawlerEvent

public abstract static class CrawlerEvent.CrawlerEventBuilder<C extends CrawlerEvent,B extends CrawlerEvent.CrawlerEventBuilder<C,B>>
extends Event.EventBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
CrawlerEventBuilder()

Method Summary

Modifier and Type	Method	Description
abstract C	build()
B	commandClass(Class<? extends Command> commandClass)	The command class firing a CrawlerEvent.CRAWLER_COMMAND_BEGIN or CrawlerEvent.CRAWLER_COMMAND_END event, or null for all other events.
B	crawlEntry(CrawlerEntry crawlEntry)	Gets the document being processed associated with this event.
B	crawlSession(CrawlerSession crawlSession)
protected abstract B	self()
String	toString()

Methods inherited from class com.norconex.commons.lang.event.Event.EventBuilder

exception, message, name

Methods inherited from class com.norconex.commons.lang.event.EventObjectAdapter.EventObjectAdapterBuilder

source

Methods inherited from class java.lang.Object

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

Constructor Details

CrawlerEventBuilder

public CrawlerEventBuilder()

Method Details

crawlEntry

public B crawlEntry(CrawlerEntry crawlEntry)

Gets the document being processed associated with this event. CRAWLER_* events will return a null doc.

Returns:

this.

crawlSession

public B crawlSession(CrawlerSession crawlSession)

Returns:

this.

commandClass

public B commandClass(Class<? extends Command> commandClass)

The command class firing a CrawlerEvent.CRAWLER_COMMAND_BEGIN or CrawlerEvent.CRAWLER_COMMAND_END event, or null for all other events.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class Event.EventBuilder<C extends CrawlerEvent,B extends CrawlerEvent.CrawlerEventBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Event.EventBuilder<C extends CrawlerEvent,B extends CrawlerEvent.CrawlerEventBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Event.EventBuilder<C extends CrawlerEvent,B extends CrawlerEvent.CrawlerEventBuilder<C,B>>