- call(String, String[]) - Method in class com.rivescript.lang.Java
-
Handler for when a user invokes the object.
- call(String, String[]) - Method in class com.rivescript.lang.Perl
-
Handler for when a user invokes the object.
- call(String, String[]) - Method in interface com.rivescript.macro.ObjectHandler
-
Handler for when a user invokes the object.
- call(RiveScript, String[]) - Method in interface com.rivescript.macro.Subroutine
-
The implemenatation of the Java object macro.
- clear(String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- clear(String) - Method in class com.rivescript.session.NoOpSessionManager
-
- clear(String) - Method in interface com.rivescript.session.SessionManager
-
Clears a user's variables.
- clearAll() - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- clearAll() - Method in class com.rivescript.session.NoOpSessionManager
-
- clearAll() - Method in interface com.rivescript.session.SessionManager
-
Clear all variables of all users.
- clearAllUservars() - Method in class com.rivescript.RiveScript
-
Clears all variables for all users.
- clearUservars(String) - Method in class com.rivescript.RiveScript
-
Clears a user's variables.
- com.rivescript - package com.rivescript
-
- com.rivescript.ast - package com.rivescript.ast
-
Provides Abstract Syntax Tree (AST) classes.
- com.rivescript.cmd - package com.rivescript.cmd
-
Provides command classes.
- com.rivescript.exception - package com.rivescript.exception
-
Provides exception classes.
- com.rivescript.lang - package com.rivescript.lang
-
Provides programming language support classes.
- com.rivescript.macro - package com.rivescript.macro
-
Provides macro classes.
- com.rivescript.parser - package com.rivescript.parser
-
Provides parser classes.
- com.rivescript.regexp - package com.rivescript.regexp
-
Provides regular expression classes.
- com.rivescript.session - package com.rivescript.session
-
Provides session manager classes.
- com.rivescript.sorting - package com.rivescript.sorting
-
Provides sorting classes.
- com.rivescript.util - package com.rivescript.util
-
Provides util classes.
- ConcurrentHashMapSessionManager - Class in com.rivescript.session
-
Implements the default in-memory
SessionManager
for RiveScript, based on a
ConcurrentHashMap
.
- ConcurrentHashMapSessionManager() - Constructor for class com.rivescript.session.ConcurrentHashMapSessionManager
-
- Config - Class in com.rivescript
-
User-configurable properties of the
RiveScript
interpreter.
- Config() - Constructor for class com.rivescript.Config
-
- Config.Builder - Class in com.rivescript
-
- countWords(String, boolean) - Static method in class com.rivescript.util.StringUtils
-
Counts the number of words in a String
.
- currentUser() - Method in class com.rivescript.RiveScript
-
Returns the current user's ID.
- get(String, String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- get(String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- get(String, String) - Method in class com.rivescript.session.NoOpSessionManager
-
- get(String) - Method in class com.rivescript.session.NoOpSessionManager
-
- get(String, String) - Method in interface com.rivescript.session.SessionManager
-
Returns a user variable.
- get(String) - Method in interface com.rivescript.session.SessionManager
-
Returns all variables for a user.
- getAll() - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- getAll() - Method in class com.rivescript.session.NoOpSessionManager
-
- getAll() - Method in interface com.rivescript.session.SessionManager
-
Returns all variables about all users.
- getAlpha() - Method in class com.rivescript.sorting.SortTrack
-
- getArray() - Method in class com.rivescript.ast.Begin
-
Returns the arrays.
- getAtomic() - Method in class com.rivescript.sorting.SortTrack
-
- getBegin() - Method in class com.rivescript.ast.Root
-
Returns the "begin block" (configuration) data.
- getCode() - Method in class com.rivescript.ast.ObjectMacro
-
Returns the source code of this object.
- getCode() - Method in enum com.rivescript.cmd.Shell.Color
-
- getCondition() - Method in class com.rivescript.ast.Trigger
-
Returns the conditions of this trigger.
- getDepth() - Method in class com.rivescript.Config
-
Returns the recursion depth limit.
- getDepth() - Method in class com.rivescript.RiveScript
-
Returns the recursion depth limit.
- getErrorMessages() - Method in class com.rivescript.Config
-
Returns the custom error message overrides.
- getErrorMessages() - Method in class com.rivescript.RiveScript
-
Returns the error messages (unmodifiable).
- getGlobal() - Method in class com.rivescript.ast.Begin
-
Returns the global variables.
- getGlobal(String) - Method in class com.rivescript.RiveScript
-
Returns a global variable.
- getHistory(String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- getHistory(String) - Method in class com.rivescript.session.NoOpSessionManager
-
- getHistory(String) - Method in interface com.rivescript.session.SessionManager
-
Returns a user's history.
- getHistory() - Method in class com.rivescript.session.UserData
-
- getIncludes() - Method in class com.rivescript.ast.Topic
-
Returns the includes of this topic.
- getInherits() - Method in class com.rivescript.ast.Topic
-
Returns the inherits of this topic.
- getInput() - Method in class com.rivescript.session.History
-
- getInput(int) - Method in class com.rivescript.session.History
-
- getLanguage() - Method in class com.rivescript.ast.ObjectMacro
-
Returns the programming language of this object.
- getLastMatch(String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- getLastMatch(String) - Method in class com.rivescript.session.NoOpSessionManager
-
- getLastMatch(String) - Method in interface com.rivescript.session.SessionManager
-
Returns a user's last matched trigger.
- getLastMatch() - Method in class com.rivescript.session.UserData
-
- getName() - Method in class com.rivescript.ast.ObjectMacro
-
Returns the name of this object.
- getNumber() - Method in class com.rivescript.sorting.SortTrack
-
- getObjects() - Method in class com.rivescript.ast.Root
-
Returns the objects.
- getOption() - Method in class com.rivescript.sorting.SortTrack
-
- getPerson() - Method in class com.rivescript.ast.Begin
-
Retuns the person variables.
- getPerson(String) - Method in class com.rivescript.RiveScript
-
Returns a person substitution pattern.
- getPerson() - Method in class com.rivescript.sorting.SortBuffer
-
- getPointer() - Method in class com.rivescript.sorting.SortedTriggerEntry
-
- getPound() - Method in class com.rivescript.sorting.SortTrack
-
- getPrevious() - Method in class com.rivescript.ast.Trigger
-
Returns the previous of this trigger.
- getRedirect() - Method in class com.rivescript.ast.Trigger
-
Returns the redirect of this trigger.
- getReply() - Method in class com.rivescript.ast.Trigger
-
Returns the replies of this trigger.
- getReply() - Method in class com.rivescript.session.History
-
- getReply(int) - Method in class com.rivescript.session.History
-
- getSessionManager() - Method in class com.rivescript.Config
-
- getStar() - Method in class com.rivescript.sorting.SortTrack
-
- getSub() - Method in class com.rivescript.ast.Begin
-
Returns the substitution variables.
- getSub() - Method in class com.rivescript.sorting.SortBuffer
-
- getSubstitution(String) - Method in class com.rivescript.RiveScript
-
Returns a substitution pattern.
- getThats(String) - Method in class com.rivescript.sorting.SortBuffer
-
- getThats() - Method in class com.rivescript.sorting.SortBuffer
-
- getTopic(String) - Method in class com.rivescript.ast.Root
-
Returns the topic with the given name.
- getTopic(String) - Method in class com.rivescript.sorting.SortBuffer
-
- getTopics() - Method in class com.rivescript.ast.Root
-
Returns the topics.
- getTopics() - Method in class com.rivescript.sorting.SortBuffer
-
- getTrigger() - Method in class com.rivescript.ast.Trigger
-
Returns the trigger pattern of this trigger.
- getTrigger() - Method in class com.rivescript.sorting.SortedTriggerEntry
-
- getTriggers() - Method in class com.rivescript.ast.Topic
-
Returns the triggers of this topic.
- getUnder() - Method in class com.rivescript.sorting.SortTrack
-
- getUnicodePunctuation() - Method in class com.rivescript.Config
-
Returns the unicode punctuation pattern.
- getUnicodePunctuation() - Method in class com.rivescript.RiveScript
-
Returns the unicode punctuation pattern.
- getUservar(String, String) - Method in class com.rivescript.RiveScript
-
Returns a user variable.
- getUservars(String) - Method in class com.rivescript.RiveScript
-
Returns all variables for a user.
- getVar() - Method in class com.rivescript.ast.Begin
-
Returns the bot variables.
- getVariable(String) - Method in class com.rivescript.RiveScript
-
Returns a bot variable.
- getVariable(String) - Method in class com.rivescript.session.UserData
-
- getVariables() - Method in class com.rivescript.session.UserData
-
- getVersion() - Static method in class com.rivescript.RiveScript
-
Returns the RiveScript library version, or null
if it cannot be determined.
- getWild() - Method in class com.rivescript.sorting.SortTrack
-
- init(RiveScript) - Method in class com.rivescript.cmd.Shell
-
Initializes the RiveScript instance.
- init(String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- init(String) - Method in class com.rivescript.session.NoOpSessionManager
-
- init(String) - Method in interface com.rivescript.session.SessionManager
-
Makes sure a username has a session (creates one if not).
- isForceCase() - Method in class com.rivescript.Config
-
Returns whether forcing triggers to lowercase is enabled.
- isForceCase() - Method in class com.rivescript.parser.ParserConfig
-
Returns whether forcing triggers to lowercase is enabled.
- isForceCase() - Method in class com.rivescript.RiveScript
-
Returns whether forcing triggers to lowercase is enabled.
- isStrict() - Method in class com.rivescript.Config
-
Returns whether strict syntax checking is enabled.
- isStrict() - Method in class com.rivescript.parser.ParserConfig
-
Returns whether strict syntax checking is enabled.
- isStrict() - Method in class com.rivescript.RiveScript
-
Returns whether strict syntax checking is enabled.
- isThrowExceptions() - Method in class com.rivescript.Config
-
Returns whether exception throwing is enabled.
- isThrowExceptions() - Method in class com.rivescript.RiveScript
-
Returns whether exception throwing is enabled.
- isUtf8() - Method in class com.rivescript.Config
-
Returns whether UTF-8 mode is enabled for user messages and triggers.
- isUtf8() - Method in class com.rivescript.parser.ParserConfig
-
Returns whether UTF-8 mode is enabled for user messages and triggers.
- isUtf8() - Method in class com.rivescript.RiveScript
-
Returns whether UTF-8 mode is enabled for user messages and triggers.
- RE_ANY_TAG - Static variable in class com.rivescript.regexp.Regexp
-
- RE_ARRAY - Static variable in class com.rivescript.regexp.Regexp
-
- RE_BOT_VAR - Static variable in class com.rivescript.regexp.Regexp
-
- RE_CALL - Static variable in class com.rivescript.regexp.Regexp
-
- RE_CONDITION - Static variable in class com.rivescript.regexp.Regexp
-
- RE_INHERITS - Static variable in class com.rivescript.regexp.Regexp
-
- RE_INPUT - Static variable in class com.rivescript.regexp.Regexp
-
- RE_META - Static variable in class com.rivescript.regexp.Regexp
-
- RE_NASTIES - Static variable in class com.rivescript.regexp.Regexp
-
- RE_OPTIONAL - Static variable in class com.rivescript.regexp.Regexp
-
- RE_PLACEHOLDER - Static variable in class com.rivescript.regexp.Regexp
-
- RE_RANDOM - Static variable in class com.rivescript.regexp.Regexp
-
- RE_REDIRECT - Static variable in class com.rivescript.regexp.Regexp
-
- RE_REPLY - Static variable in class com.rivescript.regexp.Regexp
-
- RE_SET - Static variable in class com.rivescript.regexp.Regexp
-
- RE_SYMBOLS - Static variable in class com.rivescript.regexp.Regexp
-
- RE_TOPIC - Static variable in class com.rivescript.regexp.Regexp
-
- RE_USER_VAR - Static variable in class com.rivescript.regexp.Regexp
-
- RE_WEIGHT - Static variable in class com.rivescript.regexp.Regexp
-
- RE_ZERO_WITH_STAR - Static variable in class com.rivescript.regexp.Regexp
-
- Regexp - Class in com.rivescript.regexp
-
Miscellaneous compiled Pattern
constants.
- Regexp() - Constructor for class com.rivescript.regexp.Regexp
-
- removeHandler(String) - Method in class com.rivescript.RiveScript
-
Removes an object macro language handler.
- removeSubroutine(String) - Method in class com.rivescript.RiveScript
-
Removes a Java object macro.
- RepliesNotSortedException - Exception in com.rivescript.exception
-
Thrown to indicate the replies are not sorted.
- RepliesNotSortedException() - Constructor for exception com.rivescript.exception.RepliesNotSortedException
-
Creates a new RepliesNotSortedException
.
- RepliesNotSortedException(String) - Constructor for exception com.rivescript.exception.RepliesNotSortedException
-
Creates a new RepliesNotSortedException
with the given message.
- reply(String, String) - Method in class com.rivescript.RiveScript
-
Returns a reply from the bot for a user's message.
- ReplyNotFoundException - Exception in com.rivescript.exception
-
Thrown to indicate no reply was found.
- ReplyNotFoundException() - Constructor for exception com.rivescript.exception.ReplyNotFoundException
-
Creates a new ReplyNotFoundException
.
- ReplyNotFoundException(String) - Constructor for exception com.rivescript.exception.ReplyNotFoundException
-
Creates a new ReplyNotFoundException
with the given message.
- ReplyNotMatchedException - Exception in com.rivescript.exception
-
Thrown to indicate no reply matched.
- ReplyNotMatchedException() - Constructor for exception com.rivescript.exception.ReplyNotMatchedException
-
Creates a new ReplyNotMatchedException
.
- ReplyNotMatchedException(String) - Constructor for exception com.rivescript.exception.ReplyNotMatchedException
-
Creates a new ReplyNotMatchedException
with the given message.
- RiveScript - Class in com.rivescript
-
A RiveScript interpreter written in Java.
- RiveScript() - Constructor for class com.rivescript.RiveScript
-
- RiveScript(Config) - Constructor for class com.rivescript.RiveScript
-
- RiveScriptException - Exception in com.rivescript
-
Thrown to indicate a RiveScript error.
- RiveScriptException() - Constructor for exception com.rivescript.RiveScriptException
-
Creates a new RiveScriptException
.
- RiveScriptException(String) - Constructor for exception com.rivescript.RiveScriptException
-
Creates a new RiveScriptException
with the given message.
- RiveScriptException(String, Throwable) - Constructor for exception com.rivescript.RiveScriptException
-
Creates a new RiveScriptException
with the given message and cause.
- RiveScriptException(Throwable) - Constructor for exception com.rivescript.RiveScriptException
-
Creates a new RiveScriptException
with the given cause.
- Root - Class in com.rivescript.ast
-
Represents the root of the Abstract Syntax Tree (AST).
- Root() - Constructor for class com.rivescript.ast.Root
-
Creates a new Abstract Syntax Tree (AST) containing an empty "random" topic.
- RS_VERSION - Static variable in class com.rivescript.parser.Parser
-
The supported version of the RiveScript language.
- run(String[]) - Method in class com.rivescript.cmd.Shell
-
Runs the RiveScript bot.
- sessionManager(SessionManager) - Method in class com.rivescript.Config.Builder
-
- SessionManager - Interface in com.rivescript.session
-
Interface for RiveScript user user variables.
- set(String, String, String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- set(String, Map<String, String>) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- set(String, String, String) - Method in class com.rivescript.session.NoOpSessionManager
-
- set(String, Map<String, String>) - Method in class com.rivescript.session.NoOpSessionManager
-
- set(String, String, String) - Method in interface com.rivescript.session.SessionManager
-
Sets a user's variable.
- set(String, Map<String, String>) - Method in interface com.rivescript.session.SessionManager
-
Sets a user's variables.
- setArray(Map<String, List<String>>) - Method in class com.rivescript.ast.Begin
-
Sets the arrays.
- setBegin(Begin) - Method in class com.rivescript.ast.Root
-
Sets the "begin block" (configuration) data.
- setCode(List<String>) - Method in class com.rivescript.ast.ObjectMacro
-
Sets the source code of this object.
- setCondition(List<String>) - Method in class com.rivescript.ast.Trigger
-
Sets the conditions of this trigger.
- setGlobal(Map<String, String>) - Method in class com.rivescript.ast.Begin
-
Sets the global variables.
- setGlobal(String, String) - Method in class com.rivescript.RiveScript
-
Sets a global variable.
- setHandler(String, ObjectHandler) - Method in class com.rivescript.RiveScript
-
Sets a custom language handler for RiveScript object macros.
- setIncludes(Map<String, Boolean>) - Method in class com.rivescript.ast.Topic
-
Sets the includes of this topic.
- setInherits(Map<String, Boolean>) - Method in class com.rivescript.ast.Topic
-
Sets the inherits of this topic.
- setLanguage(String) - Method in class com.rivescript.ast.ObjectMacro
-
Sets the programming language of this object.
- setLastMatch(String, String) - Method in class com.rivescript.session.ConcurrentHashMapSessionManager
-
- setLastMatch(String, String) - Method in class com.rivescript.session.NoOpSessionManager
-
- setLastMatch(String, String) - Method in interface com.rivescript.session.SessionManager
-
Sets a user's the last matched trigger.
- setLastMatch(String) - Method in class com.rivescript.session.UserData
-
- setName(String) - Method in class com.rivescript.ast.ObjectMacro
-
Sets the name of this object.
- setObjects(List<ObjectMacro>) - Method in class com.rivescript.ast.Root
-
Sets the objects.
- setPerson(Map<String, String>) - Method in class com.rivescript.ast.Begin
-
Sets the person variables.
- setPerson(String, String) - Method in class com.rivescript.RiveScript
-
Sets a person substitution pattern.
- setPerson(List<String>) - Method in class com.rivescript.sorting.SortBuffer
-
- setPointer(Trigger) - Method in class com.rivescript.sorting.SortedTriggerEntry
-
- setPrevious(String) - Method in class com.rivescript.ast.Trigger
-
Sets the previous of this trigger.
- setRedirect(String) - Method in class com.rivescript.ast.Trigger
-
Sets the redirect of this trigger.
- setReply(List<String>) - Method in class com.rivescript.ast.Trigger
-
Sets the replies of this trigger.
- setSub(Map<String, String>) - Method in class com.rivescript.ast.Begin
-
Sets the substitution variables.
- setSub(List<String>) - Method in class com.rivescript.sorting.SortBuffer
-
- setSubroutine(String, Subroutine) - Method in class com.rivescript.RiveScript
-
Defines a Java object macro.
- setSubstitution(String, String) - Method in class com.rivescript.RiveScript
-
Sets a substitution pattern.
- setTopics(Map<String, Topic>) - Method in class com.rivescript.ast.Root
-
Sets the topics.
- setTrigger(String) - Method in class com.rivescript.ast.Trigger
-
Sets the trigger pattern of this trigger.
- setTrigger(String) - Method in class com.rivescript.sorting.SortedTriggerEntry
-
- setTriggers(List<Trigger>) - Method in class com.rivescript.ast.Topic
-
Sets the triggers of this topic.
- setUservar(String, String, String) - Method in class com.rivescript.RiveScript
-
Sets a user variable.
- setUservars(String, Map<String, String>) - Method in class com.rivescript.RiveScript
-
Set a user's variables.
- setVar(Map<String, String>) - Method in class com.rivescript.ast.Begin
-
Sets the bot variables.
- setVariable(String, String) - Method in class com.rivescript.RiveScript
-
Sets a bot variable.
- setVariable(String, String) - Method in class com.rivescript.session.UserData
-
- Shell - Class in com.rivescript.cmd
-
Stand-alone RiveScript Interpreter.
- Shell() - Constructor for class com.rivescript.cmd.Shell
-
- Shell.Color - Enum in com.rivescript.cmd
-
The color names.
- SortBuffer - Class in com.rivescript.sorting
-
Sort buffer data.
- SortBuffer() - Constructor for class com.rivescript.sorting.SortBuffer
-
- SortedTriggerEntry - Class in com.rivescript.sorting
-
Holds a sorted trigger and the pointer to that trigger's data
- SortedTriggerEntry(String, Trigger) - Constructor for class com.rivescript.sorting.SortedTriggerEntry
-
- sortReplies() - Method in class com.rivescript.RiveScript
-
Sorts the reply structures in memory for optimal matching.
- SortTrack - Class in com.rivescript.sorting
-
Temporary categorization of triggers while sorting.
- SortTrack() - Constructor for class com.rivescript.sorting.SortTrack
-
- stream(String) - Method in class com.rivescript.RiveScript
-
Loads RiveScript source code from a text buffer, with line breaks after each line.
- stream(String[]) - Method in class com.rivescript.RiveScript
-
Loads RiveScript source code from a String
array, one line per item.
- strict(boolean) - Method in class com.rivescript.Config.Builder
-
Sets whether strict syntax checking is enabled.
- strict(boolean) - Method in class com.rivescript.parser.ParserConfig.Builder
-
Sets whether strict syntax checking is enabled.
- StringUtils - Class in com.rivescript.util
-
Miscellaneous String
utility methods.
- StringUtils() - Constructor for class com.rivescript.util.StringUtils
-
- stripNasties(String) - Static method in class com.rivescript.util.StringUtils
-
Strips special characters out of a String
.
- Subroutine - Interface in com.rivescript.macro
-
Interface for RiveScript object macros written in Java.