Swift
summaryrefslogtreecommitdiffstats
path: root/src/com/isode/stroke/elements/Form.java
diff options
context:
space:
mode:
authorMili Verma <mili.verma@isode.com>2012-01-06 15:00:55 (GMT)
committerKevin Smith <git@kismith.co.uk>2012-01-09 15:54:52 (GMT)
commitcc760bfd15caadb56bfef477cb54dc94c25f7fa7 (patch)
tree05f5918b97488b05ca1266c0644a3874adb98129 /src/com/isode/stroke/elements/Form.java
parent12b1d667965556002ea0fd300a71bcdf57634e90 (diff)
downloadstroke-cc760bfd15caadb56bfef477cb54dc94c25f7fa7.zip
stroke-cc760bfd15caadb56bfef477cb54dc94c25f7fa7.tar.bz2
Port Adhoc commands to Stroke
This patch ports the Adhoc commands from Swiften to Stroke. It also ports their unit tests. Test-information: Unit tests pass. MLC able to use the ad-hoc command fine.
Diffstat (limited to 'src/com/isode/stroke/elements/Form.java')
-rw-r--r--src/com/isode/stroke/elements/Form.java242
1 files changed, 242 insertions, 0 deletions
diff --git a/src/com/isode/stroke/elements/Form.java b/src/com/isode/stroke/elements/Form.java
new file mode 100644
index 0000000..1c2e830
--- /dev/null
+++ b/src/com/isode/stroke/elements/Form.java
@@ -0,0 +1,242 @@
+/*
+ * Copyright (c) 2012 Isode Limited, London, England.
+ * All rights reserved.
+ */
+/*
+ * Copyright (c) 2010 Remko Tronçon
+ * All rights reserved.
+ */
+
+package com.isode.stroke.elements;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.isode.stroke.elements.FormField.HiddenFormField;
+
+/**
+ * XEP-0004 Data form. For the relevant Fields, the parsers and serialisers
+ * protect the API user against the strange multi-value instead of newline thing
+ * by transforming them.
+ */
+public class Form extends Payload {
+ /**
+ * Attribute "type"
+ */
+ public static final String FORM_ATTRIBUTE_TYPE = "type";
+
+ /**
+ * Element "title"
+ */
+ public static final String FORM_ELEMENT_TITLE = "title";
+
+ /**
+ * Element "instructions"
+ */
+ public static final String FORM_ELEMENT_INSTRUCTIONS = "instructions";
+
+ /**
+ * Element "field"
+ */
+ public static final String FORM_ELEMENT_FIELD = "field";
+
+ /**
+ * Type of form
+ */
+ public enum Type {
+ /**
+ * The form-processing entity is asking the form-submitting entity to
+ * complete a form.
+ */
+ FORM_TYPE("form"),
+ /**
+ * The form-submitting entity is submitting data to the form-processing
+ * entity.
+ */
+ SUBMIT_TYPE("submit"),
+ /**
+ * The form-submitting entity has cancelled submission of data to the
+ * form-processing entity.
+ */
+ CANCEL_TYPE("cancel"),
+ /**
+ * The form-processing entity is returning data (e.g., search results)
+ * to the form-submitting entity, or the data is a generic data set.
+ */
+ RESULT_TYPE("result");
+
+ private String stringForm_;
+
+ private Type(String stringForm) {
+ stringForm_ = stringForm;
+ }
+
+ /**
+ * Get type from its string form.
+ *
+ * @param stringForm String form of type, can be null
+ *
+ * @return Corresponding type if match found, otherwise
+ * {@link Type#FORM_TYPE}. Will never be null.
+ */
+ public static Type getType(String stringForm) {
+ if (stringForm != null) {
+ for (Type type : Type.values()) {
+ if (type.stringForm_.equals(stringForm)) {
+ return type;
+ }
+ }
+ }
+
+ return FORM_TYPE;
+ }
+
+ /**
+ * @return String form of type, will never be null
+ */
+ public String getStringForm() {
+ return stringForm_;
+ }
+ };
+
+ private List<FormField> fields_ = new ArrayList<FormField>();
+ private String title_ = "";
+ private String instructions_ = "";
+ private Type type_;
+
+ /**
+ * Create a form of the given type.
+ *
+ * @param type Form type, if null then {@link Type#FORM_TYPE} is assumed
+ */
+ public Form(Type type) {
+ setType(type);
+ }
+
+ /**
+ * Create a form of {@link Type#FORM_TYPE}.
+ */
+ public Form() {
+ this(null);
+ }
+
+ /**
+ * Add to the list of fields for the form.
+ *
+ * @param field Field to add, can be null in which case it will be ignored.
+ * The instance of the form field is stored in the object, a copy
+ * is not made.
+ */
+ public void addField(FormField field) {
+ if (field != null) {
+ fields_.add(field);
+ }
+ }
+
+ /**
+ * @return List of fields for the form, will never be null. The instances of
+ * the form fields stored in the object is returned, a copy is not
+ * made.
+ */
+ public List<FormField> getFields() {
+ return new ArrayList<FormField>(fields_);
+ }
+
+ /**
+ * Set title of the form.
+ *
+ * @param title title of the form, can be null in which case an empty string
+ * will be stored
+ */
+ public void setTitle(String title) {
+ title_ = (title != null) ? title : "";
+ }
+
+ /**
+ * @return title of the form, will never be null
+ */
+ public String getTitle() {
+ return title_;
+ }
+
+ /**
+ * Set natural-language instructions for the form.
+ *
+ * @param instructions instructions for the form, can be null in which case
+ * an empty string will be stored
+ */
+ public void setInstructions(String instructions) {
+ instructions_ = (instructions != null) ? instructions : "";
+ }
+
+ /**
+ * @return natural-language instructions for the form, will never be null
+ */
+ public String getInstructions() {
+ return instructions_;
+ }
+
+ /**
+ * Set type of the form.
+ *
+ * @param type Form type, if null then {@link Type#FORM_TYPE} is assumed
+ */
+ public void setType(Type type) {
+ type_ = (type != null) ? type : Type.FORM_TYPE;
+ }
+
+ /**
+ * @return type of the form, will never be null
+ */
+ public Type getType() {
+ return type_;
+ }
+
+ /**
+ * @return Value of the "FORM_TYPE" hidden form field if it is present in
+ * the form, an empty string otherwise, will never be null
+ */
+ public String getFormType() {
+ String value = null;
+
+ FormField field = getField("FORM_TYPE");
+ try {
+ HiddenFormField f = (HiddenFormField) field;
+ if (f != null) {
+ value = f.getValue();
+ }
+ } catch (ClassCastException e) {
+ // value remains null
+ }
+
+ return ((value != null) ? value : "");
+ }
+
+ /**
+ * Get form field for the given name.
+ *
+ * @param name Name of form field to retrieve, can be null in which case
+ * null will be returned
+ *
+ * @return Form field with the given name if it is present in the form, null
+ * otherwise. The instance of the form field stored in the object is
+ * returned, a copy is not made.
+ */
+ public FormField getField(String name) {
+ if (name != null) {
+ for (FormField field : fields_) {
+ if (field.getName().equals(name)) {
+ return field;
+ }
+ }
+ }
+
+ return null;
+ }
+
+ @Override
+ public String toString() {
+ return Form.class.getSimpleName() + "\ntitle: " + title_
+ + "\ninstructions: " + instructions_ + "\ntype: " + type_;
+ }
+}