Package org.openhab.core.voice

Class DialogContext.Builder

java.lang.Object

org.openhab.core.voice.DialogContext.Builder

Enclosing class:

DialogContext

public static class DialogContext.Builder
extends Object

Builder for DialogContext Allows to describe a dialog context without requiring the involved services to be loaded

Constructor Summary

Constructors

Constructor	Description
Builder(String keyword, Locale locale)

Method Summary

Modifier and Type	Method	Description
DialogContext	build()	Creates a new DialogContext
DialogContext.Builder	withDialogGroup(@Nullable String dialogGroup)
DialogContext.Builder	withHLI(@Nullable HumanLanguageInterpreter service)
DialogContext.Builder	withHLIs(Collection<HumanLanguageInterpreter> services)
DialogContext.Builder	withHLIs(List<HumanLanguageInterpreter> services)
DialogContext.Builder	withKeyword(@Nullable String keyword)
DialogContext.Builder	withKS(@Nullable KSService service)
DialogContext.Builder	withListeningItem(@Nullable String listeningItem)
DialogContext.Builder	withLocale(@Nullable Locale locale)
DialogContext.Builder	withLocationItem(@Nullable String locationItem)
DialogContext.Builder	withMelody(@Nullable String listeningMelody)
DialogContext.Builder	withSink(@Nullable AudioSink sink)
DialogContext.Builder	withSource(@Nullable AudioSource source)
DialogContext.Builder	withSTT(@Nullable STTService service)
DialogContext.Builder	withTTS(@Nullable TTSService service)
DialogContext.Builder	withVoice(@Nullable Voice voice)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String keyword,
 Locale locale)

Method Details

withSource

public DialogContext.Builder withSource(@Nullable AudioSource source)

withSink

public DialogContext.Builder withSink(@Nullable AudioSink sink)

withKS

public DialogContext.Builder withKS(@Nullable KSService service)

withSTT

public DialogContext.Builder withSTT(@Nullable STTService service)

withTTS

public DialogContext.Builder withTTS(@Nullable TTSService service)

withHLI

public DialogContext.Builder withHLI(@Nullable HumanLanguageInterpreter service)

withHLIs

public DialogContext.Builder withHLIs(Collection<HumanLanguageInterpreter> services)

withHLIs

public DialogContext.Builder withHLIs(List<HumanLanguageInterpreter> services)

withKeyword

public DialogContext.Builder withKeyword(@Nullable String keyword)

withVoice

public DialogContext.Builder withVoice(@Nullable Voice voice)

withDialogGroup

public DialogContext.Builder withDialogGroup(@Nullable String dialogGroup)

withLocationItem

public DialogContext.Builder withLocationItem(@Nullable String locationItem)

withListeningItem

public DialogContext.Builder withListeningItem(@Nullable String listeningItem)

withMelody

public DialogContext.Builder withMelody(@Nullable String listeningMelody)

withLocale

public DialogContext.Builder withLocale(@Nullable Locale locale)

build

public DialogContext build()
                    throws IllegalStateException

Creates a new DialogContext

Returns:

a DialogContext with the configured components and options

Throws:

IllegalStateException - if a required dialog component is missing