org.torproject.metrics.bot.factoids

Interface Factoid

All Known Implementing Classes:

AutonomousSystemFactoid, CountryFactoid, NetworkSizeFactoid, StaticFactoid

public interface Factoid

Generates a response to an interactive query when a trigger word is used.

Author:

Iain R. Learmonth <irl@torproject.org>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFactoid(java.lang.String lookup) Returns the factoid's response based on a lookup parameter.
java.lang.Boolean	isTriggered(java.lang.String trigger) Checks if a word a trigger word for this factoid.

Method Detail

isTriggered

java.lang.Boolean isTriggered(java.lang.String trigger)

Checks if a word a trigger word for this factoid.

Parameters:

trigger - the word to check

Returns:

true if the word is a trigger word for this factoid, otherwise false

getFactoid

java.lang.String getFactoid(java.lang.String lookup)

Returns the factoid's response based on a lookup parameter. The lookup parameter may be null, but in this case the response may just be a human readable error message.

Parameters:

lookup - a parameter to pass to the factoid that may influence the response

Returns:

a human readable response to the lookup parameter