org.torproject.metrics.bot.factoids

Class FactoidConfiguration

java.lang.Object

org.torproject.metrics.bot.factoids.FactoidConfiguration

public class FactoidConfiguration
extends java.lang.Object

Contains the configuration for factoids as loaded from the XML configuration. The XML configuration is included in the source for metrics-bot at src/main/resources/factoids.xml.

Currently only the definition of static factoids is supported in the configuration file. These consist of one or more trigger words and a single static response.

An example factoids.xml is shown below:

 <factoids>
  <factoid>
   <trigger>ask</trigger>
   <response>Please don't ask to ask your question, just ask.
    It's useful to include the version of Tor Browser or tor that you're
    using and the operating system.</response>
  </factoid>
 </factoids>
 

Author:

Iain R. Learmonth <irl@torproject.org>

See Also:

StaticFactoid

Method Summary

Modifier and Type	Method and Description
java.util.List<Factoid>	getFactoids() Returns a list of factoids as loaded from the XML configuration.
static FactoidConfiguration	getSingleton() Get the singleton FactoidConfiguration object.

Methods inherited from class java.lang.Object

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

Method Detail

getFactoids

public java.util.List<Factoid> getFactoids()

Returns a list of factoids as loaded from the XML configuration.

Returns:

a list of factoids as loaded from the XML configuration

getSingleton

public static FactoidConfiguration getSingleton()

Get the singleton FactoidConfiguration object.

Returns:

the singleton FactoidConfiguration object