• Home
• com.amazonaws
• aws-java-sdk-pinpointsmsvoicev2
• 1.12.780
• source code
• RegistrationFieldDisplayHints.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.pinpointsmsvoicev2.model.RegistrationFieldDisplayHints Maven / Gradle / Ivy

/*
 * 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.pinpointsmsvoicev2.model;

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

/**
 * 

 * Provides help information on the registration field.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RegistrationFieldDisplayHints implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The title of the display hint.
     * 
     */
    private String title;
    /**
     * 

     * A short description of the display hint.
     * 
     */
    private String shortDescription;
    /**
     * 

     * A full description of the display hint.
     * 
     */
    private String longDescription;
    /**
     * 

     * The title of the document the display hint is associated with.
     * 
     */
    private String documentationTitle;
    /**
     * 

     * The link to the document the display hint is associated with.
     * 
     */
    private String documentationLink;
    /**
     * 

     * An array of SelectOptionDescription objects.
     * 
     */
    private java.util.List selectOptionDescriptions;
    /**
     * 

     * The validation rules for the text field.
     * 
     */
    private String textValidationDescription;
    /**
     * 

     * Example text of what the value of a field should contain.
     * 
     */
    private String exampleTextValue;

    /**
     * 

     * The title of the display hint.
     * 
     * 
     * @param title
     *        The title of the display hint.
     */

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

    /**
     * 

     * The title of the display hint.
     * 
     * 
     * @return The title of the display hint.
     */

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

    /**
     * 

     * The title of the display hint.
     * 
     * 
     * @param title
     *        The title of the display hint.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

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

    /**
     * 

     * A short description of the display hint.
     * 
     * 
     * @param shortDescription
     *        A short description of the display hint.
     */

    public void setShortDescription(String shortDescription) {
        this.shortDescription = shortDescription;
    }

    /**
     * 

     * A short description of the display hint.
     * 
     * 
     * @return A short description of the display hint.
     */

    public String getShortDescription() {
        return this.shortDescription;
    }

    /**
     * 

     * A short description of the display hint.
     * 
     * 
     * @param shortDescription
     *        A short description of the display hint.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withShortDescription(String shortDescription) {
        setShortDescription(shortDescription);
        return this;
    }

    /**
     * 

     * A full description of the display hint.
     * 
     * 
     * @param longDescription
     *        A full description of the display hint.
     */

    public void setLongDescription(String longDescription) {
        this.longDescription = longDescription;
    }

    /**
     * 

     * A full description of the display hint.
     * 
     * 
     * @return A full description of the display hint.
     */

    public String getLongDescription() {
        return this.longDescription;
    }

    /**
     * 

     * A full description of the display hint.
     * 
     * 
     * @param longDescription
     *        A full description of the display hint.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withLongDescription(String longDescription) {
        setLongDescription(longDescription);
        return this;
    }

    /**
     * 

     * The title of the document the display hint is associated with.
     * 
     * 
     * @param documentationTitle
     *        The title of the document the display hint is associated with.
     */

    public void setDocumentationTitle(String documentationTitle) {
        this.documentationTitle = documentationTitle;
    }

    /**
     * 

     * The title of the document the display hint is associated with.
     * 
     * 
     * @return The title of the document the display hint is associated with.
     */

    public String getDocumentationTitle() {
        return this.documentationTitle;
    }

    /**
     * 

     * The title of the document the display hint is associated with.
     * 
     * 
     * @param documentationTitle
     *        The title of the document the display hint is associated with.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withDocumentationTitle(String documentationTitle) {
        setDocumentationTitle(documentationTitle);
        return this;
    }

    /**
     * 

     * The link to the document the display hint is associated with.
     * 
     * 
     * @param documentationLink
     *        The link to the document the display hint is associated with.
     */

    public void setDocumentationLink(String documentationLink) {
        this.documentationLink = documentationLink;
    }

    /**
     * 

     * The link to the document the display hint is associated with.
     * 
     * 
     * @return The link to the document the display hint is associated with.
     */

    public String getDocumentationLink() {
        return this.documentationLink;
    }

    /**
     * 

     * The link to the document the display hint is associated with.
     * 
     * 
     * @param documentationLink
     *        The link to the document the display hint is associated with.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withDocumentationLink(String documentationLink) {
        setDocumentationLink(documentationLink);
        return this;
    }

    /**
     * 

     * An array of SelectOptionDescription objects.
     * 
     * 
     * @return An array of SelectOptionDescription objects.
     */

    public java.util.List getSelectOptionDescriptions() {
        return selectOptionDescriptions;
    }

    /**
     * 

     * An array of SelectOptionDescription objects.
     * 
     * 
     * @param selectOptionDescriptions
     *        An array of SelectOptionDescription objects.
     */

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

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

    /**
     * 

     * An array of SelectOptionDescription objects.
     * 
     * 

     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setSelectOptionDescriptions(java.util.Collection)} or
     * {@link #withSelectOptionDescriptions(java.util.Collection)} if you want to override the existing values.
     * 
     * 
     * @param selectOptionDescriptions
     *        An array of SelectOptionDescription objects.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withSelectOptionDescriptions(SelectOptionDescription... selectOptionDescriptions) {
        if (this.selectOptionDescriptions == null) {
            setSelectOptionDescriptions(new java.util.ArrayList(selectOptionDescriptions.length));
        }
        for (SelectOptionDescription ele : selectOptionDescriptions) {
            this.selectOptionDescriptions.add(ele);
        }
        return this;
    }

    /**
     * 

     * An array of SelectOptionDescription objects.
     * 
     * 
     * @param selectOptionDescriptions
     *        An array of SelectOptionDescription objects.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withSelectOptionDescriptions(java.util.Collection selectOptionDescriptions) {
        setSelectOptionDescriptions(selectOptionDescriptions);
        return this;
    }

    /**
     * 

     * The validation rules for the text field.
     * 
     * 
     * @param textValidationDescription
     *        The validation rules for the text field.
     */

    public void setTextValidationDescription(String textValidationDescription) {
        this.textValidationDescription = textValidationDescription;
    }

    /**
     * 

     * The validation rules for the text field.
     * 
     * 
     * @return The validation rules for the text field.
     */

    public String getTextValidationDescription() {
        return this.textValidationDescription;
    }

    /**
     * 

     * The validation rules for the text field.
     * 
     * 
     * @param textValidationDescription
     *        The validation rules for the text field.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withTextValidationDescription(String textValidationDescription) {
        setTextValidationDescription(textValidationDescription);
        return this;
    }

    /**
     * 

     * Example text of what the value of a field should contain.
     * 
     * 
     * @param exampleTextValue
     *        Example text of what the value of a field should contain.
     */

    public void setExampleTextValue(String exampleTextValue) {
        this.exampleTextValue = exampleTextValue;
    }

    /**
     * 

     * Example text of what the value of a field should contain.
     * 
     * 
     * @return Example text of what the value of a field should contain.
     */

    public String getExampleTextValue() {
        return this.exampleTextValue;
    }

    /**
     * 

     * Example text of what the value of a field should contain.
     * 
     * 
     * @param exampleTextValue
     *        Example text of what the value of a field should contain.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RegistrationFieldDisplayHints withExampleTextValue(String exampleTextValue) {
        setExampleTextValue(exampleTextValue);
        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 (getTitle() != null)
            sb.append("Title: ").append(getTitle()).append(",");
        if (getShortDescription() != null)
            sb.append("ShortDescription: ").append(getShortDescription()).append(",");
        if (getLongDescription() != null)
            sb.append("LongDescription: ").append(getLongDescription()).append(",");
        if (getDocumentationTitle() != null)
            sb.append("DocumentationTitle: ").append(getDocumentationTitle()).append(",");
        if (getDocumentationLink() != null)
            sb.append("DocumentationLink: ").append(getDocumentationLink()).append(",");
        if (getSelectOptionDescriptions() != null)
            sb.append("SelectOptionDescriptions: ").append(getSelectOptionDescriptions()).append(",");
        if (getTextValidationDescription() != null)
            sb.append("TextValidationDescription: ").append(getTextValidationDescription()).append(",");
        if (getExampleTextValue() != null)
            sb.append("ExampleTextValue: ").append(getExampleTextValue());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof RegistrationFieldDisplayHints == false)
            return false;
        RegistrationFieldDisplayHints other = (RegistrationFieldDisplayHints) obj;
        if (other.getTitle() == null ^ this.getTitle() == null)
            return false;
        if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == false)
            return false;
        if (other.getShortDescription() == null ^ this.getShortDescription() == null)
            return false;
        if (other.getShortDescription() != null && other.getShortDescription().equals(this.getShortDescription()) == false)
            return false;
        if (other.getLongDescription() == null ^ this.getLongDescription() == null)
            return false;
        if (other.getLongDescription() != null && other.getLongDescription().equals(this.getLongDescription()) == false)
            return false;
        if (other.getDocumentationTitle() == null ^ this.getDocumentationTitle() == null)
            return false;
        if (other.getDocumentationTitle() != null && other.getDocumentationTitle().equals(this.getDocumentationTitle()) == false)
            return false;
        if (other.getDocumentationLink() == null ^ this.getDocumentationLink() == null)
            return false;
        if (other.getDocumentationLink() != null && other.getDocumentationLink().equals(this.getDocumentationLink()) == false)
            return false;
        if (other.getSelectOptionDescriptions() == null ^ this.getSelectOptionDescriptions() == null)
            return false;
        if (other.getSelectOptionDescriptions() != null && other.getSelectOptionDescriptions().equals(this.getSelectOptionDescriptions()) == false)
            return false;
        if (other.getTextValidationDescription() == null ^ this.getTextValidationDescription() == null)
            return false;
        if (other.getTextValidationDescription() != null && other.getTextValidationDescription().equals(this.getTextValidationDescription()) == false)
            return false;
        if (other.getExampleTextValue() == null ^ this.getExampleTextValue() == null)
            return false;
        if (other.getExampleTextValue() != null && other.getExampleTextValue().equals(this.getExampleTextValue()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
        hashCode = prime * hashCode + ((getShortDescription() == null) ? 0 : getShortDescription().hashCode());
        hashCode = prime * hashCode + ((getLongDescription() == null) ? 0 : getLongDescription().hashCode());
        hashCode = prime * hashCode + ((getDocumentationTitle() == null) ? 0 : getDocumentationTitle().hashCode());
        hashCode = prime * hashCode + ((getDocumentationLink() == null) ? 0 : getDocumentationLink().hashCode());
        hashCode = prime * hashCode + ((getSelectOptionDescriptions() == null) ? 0 : getSelectOptionDescriptions().hashCode());
        hashCode = prime * hashCode + ((getTextValidationDescription() == null) ? 0 : getTextValidationDescription().hashCode());
        hashCode = prime * hashCode + ((getExampleTextValue() == null) ? 0 : getExampleTextValue().hashCode());
        return hashCode;
    }

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