com.symphony.bdk.core.activity.parsing

Class SlashCommandPattern

java.lang.Object

com.symphony.bdk.core.activity.parsing.SlashCommandPattern

@API(status=INTERNAL)
public class SlashCommandPattern
extends java.lang.Object

Class representing the pattern of a SlashCommand. The string should be a list of tokens separated by whitespaces. Each token can be:

• a regular static word like "/command". This will only match the same string
• a string argument like "{argument}". This will match a single word (with no whitespaces)
• a mention argument like "{@mention}. This will match a mention
• a cashtag argument like "{$cashtag}" which will match a cashtag
• a hashtag argument like "{#cashtag}" which will match a hashtag

Constructor Summary

Constructors

Constructor and Description
SlashCommandPattern(java.lang.String pattern)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,? extends java.lang.Class<?>>	getArgumentDefinitions()
MatchResult	getMatchResult(V4Message message)
java.util.List<CommandToken>	getTokens()
void	prependToken(CommandToken token) Adds a specific token at the beginning of the slash command pattern

Methods inherited from class java.lang.Object

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

Constructor Detail

SlashCommandPattern

public SlashCommandPattern(java.lang.String pattern)

Parameters:

pattern - the slash command pattern

Throws:

{@link - SlashCommandSyntaxException} if the pattern is not well formatted

Method Detail

getTokens

public java.util.List<CommandToken> getTokens()

Returns:

the list of command tokens

prependToken

public void prependToken(CommandToken token)

Adds a specific token at the beginning of the slash command pattern

Parameters:

token - the command token to add

getArgumentDefinitions

public java.util.Map<java.lang.String,? extends java.lang.Class<?>> getArgumentDefinitions()

Returns:

the map of key-value pairs (argument name, argument type)

getMatchResult

public MatchResult getMatchResult(V4Message message)

Parameters:

message - the input message to be matched against the SlashCommandPattern

Returns:

the MatchResult object containing the status (matches or not) and the potential arguments.