io.klerch.alexa.tellask.model.AlexaOutputSlot Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alexa-skills-kit-tellask-java Show documentation

This SDK is an extension to the Alexa Skills SDK for Java. It provides a framework for handling speechlet requests with multi-variant utterances organized in YAML files that make it easy to create localized skills. This SDK also lets you build your skill in declarative style and avoids a lot of boilerplate code.

There is a newer version: 0.2.3

Show newest version

/**
 * Created by Kay Lerch (https://twitter.com/KayLerch)
 *
 * Contribute to https://github.com/KayLerch/alexa-skills-kit-tellask-java
 *
 * Attached license applies.
 * This source is licensed under GNU GENERAL PUBLIC LICENSE Version 3 as of 29 June 2007
 */
package io.klerch.alexa.tellask.model;

import io.klerch.alexa.tellask.schema.type.AlexaOutputFormat;
import org.apache.commons.lang3.Validate;

/**
 * An output slot fills the placeholder in an output utterance coming from one of the YAML files.
 * The slot is identified by a name equal to the placeholder-name, a string-parsable value and
 * an output format.
 */
public class AlexaOutputSlot {
    private AlexaOutputFormat format = AlexaOutputFormat.TEXT;
    private final Object value;
    private final String name;

    /**
     * New slot with a name equal to the placeholder-name in an utterance from one of the YAML files and
     * a string-parsable value.
     * @param name slot name. Must not be blank.
     * @param value slot value. Must be non-null.
     */
    public AlexaOutputSlot(final String name, final Object value) {
        Validate.notBlank(name, "Slotname must not be empty.");
        Validate.notNull(value, "Slot value must not be null.");
        this.name = name;
        this.value = value;
    }

    /**
     * Gets the format of the slot output in an utterance. Usually this is an SSML tag wrapped around the
     * slot value.
     * @return the format of the slot output in an utterance
     */
    public AlexaOutputFormat getFormatAs() {
        return format;
    }

    /**
     * Sets the format of the slot output in an utterance. Usually this is an SSML tag wrapped around the
     * slot value.
     * @param format the format of the slot output in an utterance. Must not be null.
     */
    public void setFormatAs(final AlexaOutputFormat format) {
        Validate.notNull(format, "Slot output format must not be null.");
        this.format = format;
    }

    /**
     * Sets the format of the slot output in an utterance. Usually this is an SSML tag wrapped around the
     * slot value.
     * @param format the format of the slot output in an utterance. Must not be null.
     * @return this
     */
    public AlexaOutputSlot formatAs(final AlexaOutputFormat format) {
        setFormatAs(format);
        return this;
    }

    /**
     * The value combined with the output format results in a SSML-string returned with this method.
     * @return The SSML-representation of the slot value.
     */
    public String getSsml() {
        return format.getSsml(value);
    }

    /**
     * Returns the slot value
     * @return slot value
     */
    public Object getValue() {
        return value;
    }

    /**
     * Returns the slot name
     * @return slot value
     */
    public String getName() {
        return name;
    }
}