com.twilio.twiml.voice.SsmlSub Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Twilio Java Helper Library
There is a newer version: 10.1.5
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.twiml.voice;

import com.twilio.twiml.TwiML;

import java.util.HashMap;
import java.util.Map;

/**
 * TwiML wrapper for {@code _{}
 */
public class SsmlSub extends TwiML {
    private final String alias;
    private final String words;

    /**
     * For XML Serialization/Deserialization
     */
    private SsmlSub() {
        this(new Builder((String) null));
    }

    /**
     * Create a new {@code _{} element
     */
    private SsmlSub(Builder b) {
        super("sub", b);
        this.alias = b.alias;
        this.words = b.words;
    }

    /**
     * The body of the TwiML element
     *
     * @return Element body as a string if present else null
     */
    protected String getElementBody() {
        return this.getWords() == null ? null : this.getWords();
    }

    /**
     * Attributes to set on the generated XML element
     *
     * @return A Map of attribute keys to values
     */
    protected Map getElementAttributes() {
        // Preserve order of attributes
        Map attrs = new HashMap<>();

        if (this.getAlias() != null) {
            attrs.put("alias", this.getAlias());
        }

        return attrs;
    }

    /**
     * Substitute a different word (or pronunciation) for selected text such as an
     * acronym or abbreviation
     *
     * @return Substitute a different word (or pronunciation) for selected text
     *         such as an acronym or abbreviation
     */
    public String getAlias() {
        return alias;
    }

    /**
     * Words to be substituted
     *
     * @return Words to be substituted
     */
    public String getWords() {
        return words;
    }

    /**
     * Create a new {@code _{} element
     */
    public static class Builder extends TwiML.Builder {
        private String alias;
        private String words;

        /**
         * Create a {@code _{} with words
         */
        public Builder(String words) {
            this.words = words;
        }

        /**
         * Substitute a different word (or pronunciation) for selected text such as an
         * acronym or abbreviation
         */
        public Builder alias(String alias) {
            this.alias = alias;
            return this;
        }

        /**
         * Create and return resulting {@code _{} element
         */
        public SsmlSub build() {
            return new SsmlSub(this);
        }
    }
}}}}}}