mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-11 22:24:50 +02:00
77e26fc575
Apply builder pattern to form fields and replace getVariable() with getFieldName(). Refer to the field name as "field name" instead of "variable" everyone, just as XEP-0004 does. Improve the high-level form API: introduce FilledForm and FillableForm which perform stronger validation and consistency checks. Also add FormFieldRegistry to enable processing of 'submit' forms where the form field types are omitted. Smack also now does omit the form field type declaration on 'submit' type forms, as it is allowed by XEP-0004.
48 lines
1.4 KiB
Java
48 lines
1.4 KiB
Java
/**
|
|
*
|
|
* Copyright 2020 Florian Schmaus
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
package org.jivesoftware.smackx.xdata;
|
|
|
|
import java.util.List;
|
|
|
|
public interface FormFieldWithOptions {
|
|
|
|
/**
|
|
* Returns a List of the available options that the user has in order to answer
|
|
* the question.
|
|
*
|
|
* @return List of the available options.
|
|
*/
|
|
List<FormField.Option> getOptions();
|
|
|
|
public interface Builder<B extends FormField.Builder<?, ?>> {
|
|
|
|
default B addOption(String option) {
|
|
return addOption(new FormField.Option(option));
|
|
}
|
|
|
|
/**
|
|
* Adds an available options to the question that the user has in order to answer
|
|
* the question.
|
|
*
|
|
* @param option a new available option for the question.
|
|
* @return a reference to this builder.
|
|
*/
|
|
B addOption(FormField.Option option);
|
|
|
|
}
|
|
}
|