001/**
002 *
003 * Copyright 2020 Florian Schmaus
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.xdata;
018
019import java.util.List;
020
021public interface FormFieldWithOptions {
022
023    /**
024     * Returns a List of the available options that the user has in order to answer
025     * the question.
026     *
027     * @return List of the available options.
028     */
029    List<FormField.Option> getOptions();
030
031    interface Builder<B extends FormField.Builder<?, ?>> {
032
033        default B addOption(String option) {
034            return addOption(new FormField.Option(option));
035        }
036
037        /**
038         * Adds an available options to the question that the user has in order to answer
039         * the question.
040         *
041         * @param option a new available option for the question.
042         * @return a reference to this builder.
043         */
044        B addOption(FormField.Option option);
045
046    }
047}