com.smartdevicelink.managers.screen.menu

Class VoiceCommand

java.lang.Object

com.smartdevicelink.managers.screen.menu.VoiceCommand

All Implemented Interfaces:

Cloneable

public class VoiceCommand
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
VoiceCommand(List<String> voiceCommands, VoiceCommandSelectionListener voiceCommandSelectionListener) Constructor that sets all parameters for this class NOTE: While it is possible to pass in null for the listener, It is the easiest way to know when it was triggered.

Method Summary

Modifier and Type	Method and Description
VoiceCommand	clone() Creates a deep copy of the object
boolean	equals(Object o) Uses our custom hashCode for VoiceCommand objects
List<String>	getVoiceCommands() The strings the user can say to activate this voice command
VoiceCommandSelectionListener	getVoiceCommandSelectionListener() The listener that will be called when the command is activated
int	hashCode() Used to compile hashcode for VoiceCommand for use to compare in equals method
void	setVoiceCommands(List<String> voiceCommands) The strings the user can say to activate this voice command
void	setVoiceCommandSelectionListener(VoiceCommandSelectionListener voiceCommandSelectionListener) The listener that will be called when the command is activated

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoiceCommand

public VoiceCommand(@NonNull
                    List<String> voiceCommands,
                    @Nullable
                    VoiceCommandSelectionListener voiceCommandSelectionListener)

Constructor that sets all parameters for this class NOTE: While it is possible to pass in null for the listener, It is the easiest way to know when it was triggered.

Parameters:

voiceCommands - The strings the user can say to activate this voice command

voiceCommandSelectionListener - The listener that will be called when the command is activated

Method Detail

setVoiceCommands

public void setVoiceCommands(@NonNull
                             List<String> voiceCommands)

The strings the user can say to activate this voice command

Parameters:

voiceCommands - - the list of commands to send to the head unit

getVoiceCommands

public List<String> getVoiceCommands()

The strings the user can say to activate this voice command

Returns:

the List of voice commands

setVoiceCommandSelectionListener

public void setVoiceCommandSelectionListener(VoiceCommandSelectionListener voiceCommandSelectionListener)

The listener that will be called when the command is activated

Parameters:

voiceCommandSelectionListener - - the listener for this object

getVoiceCommandSelectionListener

public VoiceCommandSelectionListener getVoiceCommandSelectionListener()

The listener that will be called when the command is activated

Returns:

voiceCommandSelectionListener - the listener for this object

hashCode

public int hashCode()

Used to compile hashcode for VoiceCommand for use to compare in equals method

Overrides:

hashCode in class Object

Returns:

Custom hashcode of VoiceCommand variables

equals

public boolean equals(Object o)

Uses our custom hashCode for VoiceCommand objects

Overrides:

equals in class Object

Parameters:

o - - The object to compare

Returns:

boolean of whether the objects are the same or not

clone

public VoiceCommand clone()

Creates a deep copy of the object

Overrides:

clone in class Object

Returns:

deep copy of the object, null if an exception occurred