com.symphony.bdk.core.activity.parsing

Class Arguments

java.lang.Object

com.symphony.bdk.core.activity.parsing.Arguments

@API(status=STABLE)
public class Arguments
extends java.lang.Object

Class storing arguments matching a SlashCommandPattern

Constructor Summary

Constructors

Constructor and Description
Arguments()
Arguments(java.util.Map<java.lang.String,java.lang.Object> arguments)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String argumentName)
java.util.Set<java.lang.String>	getArgumentNames()
java.lang.String	getAsString(java.lang.String argumentName)
Cashtag	getCashtag(java.lang.String argumentName)
Hashtag	getHashtag(java.lang.String argumentName)
Mention	getMention(java.lang.String argumentName)
java.lang.String	getString(java.lang.String argumentName)

Methods inherited from class java.lang.Object

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

Constructor Detail

Arguments

public Arguments()

Arguments

public Arguments(java.util.Map<java.lang.String,java.lang.Object> arguments)

Method Detail

getArgumentNames

public java.util.Set<java.lang.String> getArgumentNames()

Returns:

the set of argument names

get

public java.lang.Object get(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the argument value if present, null otherwise. Actual type of value can be String, Mention, Cashtag, Hashtag depending on the corresponding SlashCommandPattern.

getAsString

public java.lang.String getAsString(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the string representation of the argument if present, null otherwise

getString

public java.lang.String getString(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the argument value if present and if is of type String, null otherwise

getHashtag

public Hashtag getHashtag(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the argument value if present and if is of type Hashtag, null otherwise

getCashtag

public Cashtag getCashtag(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the argument value if present and if is of type Cashtag, null otherwise

getMention

public Mention getMention(java.lang.String argumentName)

Parameters:

argumentName - the name of the argument to be retrieved

Returns:

the argument value if present and if is of type Mention, null otherwise