com.amazonaws.services.qapps.model.TextInputCard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-qapps Show documentation
The AWS Java SDK for QApps module holds the client classes that are used for communicating with QApps Service
The newest version!
/*
 * Copyright 2019-2024 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.qapps.model;

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

/**
 * 
 * A card in an Amazon Q App that allows the user to input text.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TextInputCard implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The unique identifier of the text input card.
     * 
     */
    private String id;
    /**
     * 
     * The title or label of the text input card.
     * 
     */
    private String title;
    /**
     * 
     * Any dependencies or requirements for the text input card.
     * 
     */
    private java.util.List dependencies;
    /**
     * 
     * The type of the card.
     * 
     */
    private String type;
    /**
     * 
     * The placeholder text to display in the text input field.
     * 
     */
    private String placeholder;
    /**
     * 
     * The default value to pre-populate in the text input field.
     * 
     */
    private String defaultValue;

    /**
     * 
     * The unique identifier of the text input card.
     * 
     * 
     * @param id
     *        The unique identifier of the text input card.
     */

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

    /**
     * 
     * The unique identifier of the text input card.
     * 
     * 
     * @return The unique identifier of the text input card.
     */

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

    /**
     * 
     * The unique identifier of the text input card.
     * 
     * 
     * @param id
     *        The unique identifier of the text input card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

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

    /**
     * 
     * The title or label of the text input card.
     * 
     * 
     * @param title
     *        The title or label of the text input card.
     */

    public void setTitle(String title) {
        this.title = title;
    }

    /**
     * 
     * The title or label of the text input card.
     * 
     * 
     * @return The title or label of the text input card.
     */

    public String getTitle() {
        return this.title;
    }

    /**
     * 
     * The title or label of the text input card.
     * 
     * 
     * @param title
     *        The title or label of the text input card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextInputCard withTitle(String title) {
        setTitle(title);
        return this;
    }

    /**
     * 
     * Any dependencies or requirements for the text input card.
     * 
     * 
     * @return Any dependencies or requirements for the text input card.
     */

    public java.util.List getDependencies() {
        return dependencies;
    }

    /**
     * 
     * Any dependencies or requirements for the text input card.
     * 
     * 
     * @param dependencies
     *        Any dependencies or requirements for the text input card.
     */

    public void setDependencies(java.util.Collection dependencies) {
        if (dependencies == null) {
            this.dependencies = null;
            return;
        }

        this.dependencies = new java.util.ArrayList(dependencies);
    }

    /**
     * 
     * Any dependencies or requirements for the text input card.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setDependencies(java.util.Collection)} or {@link #withDependencies(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param dependencies
     *        Any dependencies or requirements for the text input card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextInputCard withDependencies(String... dependencies) {
        if (this.dependencies == null) {
            setDependencies(new java.util.ArrayList(dependencies.length));
        }
        for (String ele : dependencies) {
            this.dependencies.add(ele);
        }
        return this;
    }

    /**
     * 
     * Any dependencies or requirements for the text input card.
     * 
     * 
     * @param dependencies
     *        Any dependencies or requirements for the text input card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextInputCard withDependencies(java.util.Collection dependencies) {
        setDependencies(dependencies);
        return this;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @param type
     *        The type of the card.
     * @see CardType
     */

    public void setType(String type) {
        this.type = type;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @return The type of the card.
     * @see CardType
     */

    public String getType() {
        return this.type;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @param type
     *        The type of the card.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see CardType
     */

    public TextInputCard withType(String type) {
        setType(type);
        return this;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @param type
     *        The type of the card.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see CardType
     */

    public TextInputCard withType(CardType type) {
        this.type = type.toString();
        return this;
    }

    /**
     * 
     * The placeholder text to display in the text input field.
     * 
     * 
     * @param placeholder
     *        The placeholder text to display in the text input field.
     */

    public void setPlaceholder(String placeholder) {
        this.placeholder = placeholder;
    }

    /**
     * 
     * The placeholder text to display in the text input field.
     * 
     * 
     * @return The placeholder text to display in the text input field.
     */

    public String getPlaceholder() {
        return this.placeholder;
    }

    /**
     * 
     * The placeholder text to display in the text input field.
     * 
     * 
     * @param placeholder
     *        The placeholder text to display in the text input field.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextInputCard withPlaceholder(String placeholder) {
        setPlaceholder(placeholder);
        return this;
    }

    /**
     * 
     * The default value to pre-populate in the text input field.
     * 
     * 
     * @param defaultValue
     *        The default value to pre-populate in the text input field.
     */

    public void setDefaultValue(String defaultValue) {
        this.defaultValue = defaultValue;
    }

    /**
     * 
     * The default value to pre-populate in the text input field.
     * 
     * 
     * @return The default value to pre-populate in the text input field.
     */

    public String getDefaultValue() {
        return this.defaultValue;
    }

    /**
     * 
     * The default value to pre-populate in the text input field.
     * 
     * 
     * @param defaultValue
     *        The default value to pre-populate in the text input field.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextInputCard withDefaultValue(String defaultValue) {
        setDefaultValue(defaultValue);
        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 (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getTitle() != null)
            sb.append("Title: ").append(getTitle()).append(",");
        if (getDependencies() != null)
            sb.append("Dependencies: ").append(getDependencies()).append(",");
        if (getType() != null)
            sb.append("Type: ").append(getType()).append(",");
        if (getPlaceholder() != null)
            sb.append("Placeholder: ").append(getPlaceholder()).append(",");
        if (getDefaultValue() != null)
            sb.append("DefaultValue: ").append(getDefaultValue());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof TextInputCard == false)
            return false;
        TextInputCard other = (TextInputCard) obj;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getTitle() == null ^ this.getTitle() == null)
            return false;
        if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == false)
            return false;
        if (other.getDependencies() == null ^ this.getDependencies() == null)
            return false;
        if (other.getDependencies() != null && other.getDependencies().equals(this.getDependencies()) == false)
            return false;
        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null && other.getType().equals(this.getType()) == false)
            return false;
        if (other.getPlaceholder() == null ^ this.getPlaceholder() == null)
            return false;
        if (other.getPlaceholder() != null && other.getPlaceholder().equals(this.getPlaceholder()) == false)
            return false;
        if (other.getDefaultValue() == null ^ this.getDefaultValue() == null)
            return false;
        if (other.getDefaultValue() != null && other.getDefaultValue().equals(this.getDefaultValue()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
        hashCode = prime * hashCode + ((getDependencies() == null) ? 0 : getDependencies().hashCode());
        hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
        hashCode = prime * hashCode + ((getPlaceholder() == null) ? 0 : getPlaceholder().hashCode());
        hashCode = prime * hashCode + ((getDefaultValue() == null) ? 0 : getDefaultValue().hashCode());
        return hashCode;
    }

    @Override
    public TextInputCard clone() {
        try {
            return (TextInputCard) 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.qapps.model.transform.TextInputCardMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}