/*
 * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file 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 com.amazonaws.services.amplifyuibuilder.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * Contains the configuration settings for a <code>Form</code> user interface (UI) element for an Amplify app. A form is
 * a component you can add to your project by specifying a data source as the default configuration for the form.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Form" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Form implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The unique ID of the Amplify app associated with the form.
     * </p>
     */
    private String appId;
    /**
     * <p>
     * The name of the backend environment that is a part of the Amplify app.
     * </p>
     */
    private String environmentName;
    /**
     * <p>
     * The unique ID of the form.
     * </p>
     */
    private String id;
    /**
     * <p>
     * The name of the form.
     * </p>
     */
    private String name;
    /**
     * <p>
     * The operation to perform on the specified form.
     * </p>
     */
    private String formActionType;
    /**
     * <p>
     * Stores the configuration for the form's style.
     * </p>
     */
    private FormStyle style;
    /**
     * <p>
     * The type of data source to use to create the form.
     * </p>
     */
    private FormDataTypeConfig dataType;
    /**
     * <p>
     * Stores the information about the form's fields.
     * </p>
     */
    private java.util.Map<String, FieldConfig> fields;
    /**
     * <p>
     * Stores the visual helper elements for the form that are not associated with any data.
     * </p>
     */
    private java.util.Map<String, SectionalElement> sectionalElements;
    /**
     * <p>
     * The schema version of the form when it was imported.
     * </p>
     */
    private String schemaVersion;
    /**
     * <p>
     * One or more key-value pairs to use when tagging the form.
     * </p>
     */
    private java.util.Map<String, String> tags;
    /**
     * <p>
     * Stores the call to action configuration for the form.
     * </p>
     */
    private FormCTA cta;
    /**
     * <p>
     * Specifies an icon or decoration to display on the form.
     * </p>
     */
    private String labelDecorator;

    /**
     * <p>
     * The unique ID of the Amplify app associated with the form.
     * </p>
     * 
     * @param appId
     *        The unique ID of the Amplify app associated with the form.
     */

    public void setAppId(String appId) {
        this.appId = appId;
    }

    /**
     * <p>
     * The unique ID of the Amplify app associated with the form.
     * </p>
     * 
     * @return The unique ID of the Amplify app associated with the form.
     */

    public String getAppId() {
        return this.appId;
    }

    /**
     * <p>
     * The unique ID of the Amplify app associated with the form.
     * </p>
     * 
     * @param appId
     *        The unique ID of the Amplify app associated with the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withAppId(String appId) {
        setAppId(appId);
        return this;
    }

    /**
     * <p>
     * The name of the backend environment that is a part of the Amplify app.
     * </p>
     * 
     * @param environmentName
     *        The name of the backend environment that is a part of the Amplify app.
     */

    public void setEnvironmentName(String environmentName) {
        this.environmentName = environmentName;
    }

    /**
     * <p>
     * The name of the backend environment that is a part of the Amplify app.
     * </p>
     * 
     * @return The name of the backend environment that is a part of the Amplify app.
     */

    public String getEnvironmentName() {
        return this.environmentName;
    }

    /**
     * <p>
     * The name of the backend environment that is a part of the Amplify app.
     * </p>
     * 
     * @param environmentName
     *        The name of the backend environment that is a part of the Amplify app.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withEnvironmentName(String environmentName) {
        setEnvironmentName(environmentName);
        return this;
    }

    /**
     * <p>
     * The unique ID of the form.
     * </p>
     * 
     * @param id
     *        The unique ID of the form.
     */

    public void setId(String id) {
        this.id = id;
    }

    /**
     * <p>
     * The unique ID of the form.
     * </p>
     * 
     * @return The unique ID of the form.
     */

    public String getId() {
        return this.id;
    }

    /**
     * <p>
     * The unique ID of the form.
     * </p>
     * 
     * @param id
     *        The unique ID of the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withId(String id) {
        setId(id);
        return this;
    }

    /**
     * <p>
     * The name of the form.
     * </p>
     * 
     * @param name
     *        The name of the form.
     */

    public void setName(String name) {
        this.name = name;
    }

    /**
     * <p>
     * The name of the form.
     * </p>
     * 
     * @return The name of the form.
     */

    public String getName() {
        return this.name;
    }

    /**
     * <p>
     * The name of the form.
     * </p>
     * 
     * @param name
     *        The name of the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withName(String name) {
        setName(name);
        return this;
    }

    /**
     * <p>
     * The operation to perform on the specified form.
     * </p>
     * 
     * @param formActionType
     *        The operation to perform on the specified form.
     * @see FormActionType
     */

    public void setFormActionType(String formActionType) {
        this.formActionType = formActionType;
    }

    /**
     * <p>
     * The operation to perform on the specified form.
     * </p>
     * 
     * @return The operation to perform on the specified form.
     * @see FormActionType
     */

    public String getFormActionType() {
        return this.formActionType;
    }

    /**
     * <p>
     * The operation to perform on the specified form.
     * </p>
     * 
     * @param formActionType
     *        The operation to perform on the specified form.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see FormActionType
     */

    public Form withFormActionType(String formActionType) {
        setFormActionType(formActionType);
        return this;
    }

    /**
     * <p>
     * The operation to perform on the specified form.
     * </p>
     * 
     * @param formActionType
     *        The operation to perform on the specified form.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see FormActionType
     */

    public Form withFormActionType(FormActionType formActionType) {
        this.formActionType = formActionType.toString();
        return this;
    }

    /**
     * <p>
     * Stores the configuration for the form's style.
     * </p>
     * 
     * @param style
     *        Stores the configuration for the form's style.
     */

    public void setStyle(FormStyle style) {
        this.style = style;
    }

    /**
     * <p>
     * Stores the configuration for the form's style.
     * </p>
     * 
     * @return Stores the configuration for the form's style.
     */

    public FormStyle getStyle() {
        return this.style;
    }

    /**
     * <p>
     * Stores the configuration for the form's style.
     * </p>
     * 
     * @param style
     *        Stores the configuration for the form's style.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withStyle(FormStyle style) {
        setStyle(style);
        return this;
    }

    /**
     * <p>
     * The type of data source to use to create the form.
     * </p>
     * 
     * @param dataType
     *        The type of data source to use to create the form.
     */

    public void setDataType(FormDataTypeConfig dataType) {
        this.dataType = dataType;
    }

    /**
     * <p>
     * The type of data source to use to create the form.
     * </p>
     * 
     * @return The type of data source to use to create the form.
     */

    public FormDataTypeConfig getDataType() {
        return this.dataType;
    }

    /**
     * <p>
     * The type of data source to use to create the form.
     * </p>
     * 
     * @param dataType
     *        The type of data source to use to create the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withDataType(FormDataTypeConfig dataType) {
        setDataType(dataType);
        return this;
    }

    /**
     * <p>
     * Stores the information about the form's fields.
     * </p>
     * 
     * @return Stores the information about the form's fields.
     */

    public java.util.Map<String, FieldConfig> getFields() {
        return fields;
    }

    /**
     * <p>
     * Stores the information about the form's fields.
     * </p>
     * 
     * @param fields
     *        Stores the information about the form's fields.
     */

    public void setFields(java.util.Map<String, FieldConfig> fields) {
        this.fields = fields;
    }

    /**
     * <p>
     * Stores the information about the form's fields.
     * </p>
     * 
     * @param fields
     *        Stores the information about the form's fields.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withFields(java.util.Map<String, FieldConfig> fields) {
        setFields(fields);
        return this;
    }

    /**
     * Add a single Fields entry
     *
     * @see Form#withFields
     * @returns a reference to this object so that method calls can be chained together.
     */

    public Form addFieldsEntry(String key, FieldConfig value) {
        if (null == this.fields) {
            this.fields = new java.util.HashMap<String, FieldConfig>();
        }
        if (this.fields.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.fields.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Fields.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form clearFieldsEntries() {
        this.fields = null;
        return this;
    }

    /**
     * <p>
     * Stores the visual helper elements for the form that are not associated with any data.
     * </p>
     * 
     * @return Stores the visual helper elements for the form that are not associated with any data.
     */

    public java.util.Map<String, SectionalElement> getSectionalElements() {
        return sectionalElements;
    }

    /**
     * <p>
     * Stores the visual helper elements for the form that are not associated with any data.
     * </p>
     * 
     * @param sectionalElements
     *        Stores the visual helper elements for the form that are not associated with any data.
     */

    public void setSectionalElements(java.util.Map<String, SectionalElement> sectionalElements) {
        this.sectionalElements = sectionalElements;
    }

    /**
     * <p>
     * Stores the visual helper elements for the form that are not associated with any data.
     * </p>
     * 
     * @param sectionalElements
     *        Stores the visual helper elements for the form that are not associated with any data.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withSectionalElements(java.util.Map<String, SectionalElement> sectionalElements) {
        setSectionalElements(sectionalElements);
        return this;
    }

    /**
     * Add a single SectionalElements entry
     *
     * @see Form#withSectionalElements
     * @returns a reference to this object so that method calls can be chained together.
     */

    public Form addSectionalElementsEntry(String key, SectionalElement value) {
        if (null == this.sectionalElements) {
            this.sectionalElements = new java.util.HashMap<String, SectionalElement>();
        }
        if (this.sectionalElements.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.sectionalElements.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into SectionalElements.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form clearSectionalElementsEntries() {
        this.sectionalElements = null;
        return this;
    }

    /**
     * <p>
     * The schema version of the form when it was imported.
     * </p>
     * 
     * @param schemaVersion
     *        The schema version of the form when it was imported.
     */

    public void setSchemaVersion(String schemaVersion) {
        this.schemaVersion = schemaVersion;
    }

    /**
     * <p>
     * The schema version of the form when it was imported.
     * </p>
     * 
     * @return The schema version of the form when it was imported.
     */

    public String getSchemaVersion() {
        return this.schemaVersion;
    }

    /**
     * <p>
     * The schema version of the form when it was imported.
     * </p>
     * 
     * @param schemaVersion
     *        The schema version of the form when it was imported.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withSchemaVersion(String schemaVersion) {
        setSchemaVersion(schemaVersion);
        return this;
    }

    /**
     * <p>
     * One or more key-value pairs to use when tagging the form.
     * </p>
     * 
     * @return One or more key-value pairs to use when tagging the form.
     */

    public java.util.Map<String, String> getTags() {
        return tags;
    }

    /**
     * <p>
     * One or more key-value pairs to use when tagging the form.
     * </p>
     * 
     * @param tags
     *        One or more key-value pairs to use when tagging the form.
     */

    public void setTags(java.util.Map<String, String> tags) {
        this.tags = tags;
    }

    /**
     * <p>
     * One or more key-value pairs to use when tagging the form.
     * </p>
     * 
     * @param tags
     *        One or more key-value pairs to use when tagging the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withTags(java.util.Map<String, String> tags) {
        setTags(tags);
        return this;
    }

    /**
     * Add a single Tags entry
     *
     * @see Form#withTags
     * @returns a reference to this object so that method calls can be chained together.
     */

    public Form addTagsEntry(String key, String value) {
        if (null == this.tags) {
            this.tags = new java.util.HashMap<String, String>();
        }
        if (this.tags.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.tags.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Tags.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form clearTagsEntries() {
        this.tags = null;
        return this;
    }

    /**
     * <p>
     * Stores the call to action configuration for the form.
     * </p>
     * 
     * @param cta
     *        Stores the call to action configuration for the form.
     */

    public void setCta(FormCTA cta) {
        this.cta = cta;
    }

    /**
     * <p>
     * Stores the call to action configuration for the form.
     * </p>
     * 
     * @return Stores the call to action configuration for the form.
     */

    public FormCTA getCta() {
        return this.cta;
    }

    /**
     * <p>
     * Stores the call to action configuration for the form.
     * </p>
     * 
     * @param cta
     *        Stores the call to action configuration for the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Form withCta(FormCTA cta) {
        setCta(cta);
        return this;
    }

    /**
     * <p>
     * Specifies an icon or decoration to display on the form.
     * </p>
     * 
     * @param labelDecorator
     *        Specifies an icon or decoration to display on the form.
     * @see LabelDecorator
     */

    public void setLabelDecorator(String labelDecorator) {
        this.labelDecorator = labelDecorator;
    }

    /**
     * <p>
     * Specifies an icon or decoration to display on the form.
     * </p>
     * 
     * @return Specifies an icon or decoration to display on the form.
     * @see LabelDecorator
     */

    public String getLabelDecorator() {
        return this.labelDecorator;
    }

    /**
     * <p>
     * Specifies an icon or decoration to display on the form.
     * </p>
     * 
     * @param labelDecorator
     *        Specifies an icon or decoration to display on the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see LabelDecorator
     */

    public Form withLabelDecorator(String labelDecorator) {
        setLabelDecorator(labelDecorator);
        return this;
    }

    /**
     * <p>
     * Specifies an icon or decoration to display on the form.
     * </p>
     * 
     * @param labelDecorator
     *        Specifies an icon or decoration to display on the form.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see LabelDecorator
     */

    public Form withLabelDecorator(LabelDecorator labelDecorator) {
        this.labelDecorator = labelDecorator.toString();
        return this;
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getAppId() != null)
            sb.append("AppId: ").append(getAppId()).append(",");
        if (getEnvironmentName() != null)
            sb.append("EnvironmentName: ").append(getEnvironmentName()).append(",");
        if (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getName() != null)
            sb.append("Name: ").append(getName()).append(",");
        if (getFormActionType() != null)
            sb.append("FormActionType: ").append(getFormActionType()).append(",");
        if (getStyle() != null)
            sb.append("Style: ").append(getStyle()).append(",");
        if (getDataType() != null)
            sb.append("DataType: ").append(getDataType()).append(",");
        if (getFields() != null)
            sb.append("Fields: ").append(getFields()).append(",");
        if (getSectionalElements() != null)
            sb.append("SectionalElements: ").append(getSectionalElements()).append(",");
        if (getSchemaVersion() != null)
            sb.append("SchemaVersion: ").append(getSchemaVersion()).append(",");
        if (getTags() != null)
            sb.append("Tags: ").append(getTags()).append(",");
        if (getCta() != null)
            sb.append("Cta: ").append(getCta()).append(",");
        if (getLabelDecorator() != null)
            sb.append("LabelDecorator: ").append(getLabelDecorator());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof Form == false)
            return false;
        Form other = (Form) obj;
        if (other.getAppId() == null ^ this.getAppId() == null)
            return false;
        if (other.getAppId() != null && other.getAppId().equals(this.getAppId()) == false)
            return false;
        if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == null)
            return false;
        if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false)
            return false;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == false)
            return false;
        if (other.getFormActionType() == null ^ this.getFormActionType() == null)
            return false;
        if (other.getFormActionType() != null && other.getFormActionType().equals(this.getFormActionType()) == false)
            return false;
        if (other.getStyle() == null ^ this.getStyle() == null)
            return false;
        if (other.getStyle() != null && other.getStyle().equals(this.getStyle()) == false)
            return false;
        if (other.getDataType() == null ^ this.getDataType() == null)
            return false;
        if (other.getDataType() != null && other.getDataType().equals(this.getDataType()) == false)
            return false;
        if (other.getFields() == null ^ this.getFields() == null)
            return false;
        if (other.getFields() != null && other.getFields().equals(this.getFields()) == false)
            return false;
        if (other.getSectionalElements() == null ^ this.getSectionalElements() == null)
            return false;
        if (other.getSectionalElements() != null && other.getSectionalElements().equals(this.getSectionalElements()) == false)
            return false;
        if (other.getSchemaVersion() == null ^ this.getSchemaVersion() == null)
            return false;
        if (other.getSchemaVersion() != null && other.getSchemaVersion().equals(this.getSchemaVersion()) == false)
            return false;
        if (other.getTags() == null ^ this.getTags() == null)
            return false;
        if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
            return false;
        if (other.getCta() == null ^ this.getCta() == null)
            return false;
        if (other.getCta() != null && other.getCta().equals(this.getCta()) == false)
            return false;
        if (other.getLabelDecorator() == null ^ this.getLabelDecorator() == null)
            return false;
        if (other.getLabelDecorator() != null && other.getLabelDecorator().equals(this.getLabelDecorator()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getAppId() == null) ? 0 : getAppId().hashCode());
        hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode());
        hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
        hashCode = prime * hashCode + ((getFormActionType() == null) ? 0 : getFormActionType().hashCode());
        hashCode = prime * hashCode + ((getStyle() == null) ? 0 : getStyle().hashCode());
        hashCode = prime * hashCode + ((getDataType() == null) ? 0 : getDataType().hashCode());
        hashCode = prime * hashCode + ((getFields() == null) ? 0 : getFields().hashCode());
        hashCode = prime * hashCode + ((getSectionalElements() == null) ? 0 : getSectionalElements().hashCode());
        hashCode = prime * hashCode + ((getSchemaVersion() == null) ? 0 : getSchemaVersion().hashCode());
        hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
        hashCode = prime * hashCode + ((getCta() == null) ? 0 : getCta().hashCode());
        hashCode = prime * hashCode + ((getLabelDecorator() == null) ? 0 : getLabelDecorator().hashCode());
        return hashCode;
    }

    @Override
    public Form clone() {
        try {
            return (Form) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.amplifyuibuilder.model.transform.FormMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}