com.amazonaws.services.cloudformation.model.Parameter Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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.cloudformation.model;
import java.io.Serializable;
/**
 * 
 * The Parameter data type.
 * 
 */
public class Parameter implements Serializable, Cloneable {
    /**
     * 
     * The key associated with the parameter. If you don't specify a key and
     * value for a particular parameter, AWS CloudFormation uses the default
     * value that is specified in your template.
     * 
     */
    private String parameterKey;
    /**
     * 
     * The value associated with the parameter.
     * 
     */
    private String parameterValue;
    /**
     * 
     * During a stack update, use the existing parameter value that the stack is
     * using for a given parameter key. If you specify true, do not
     * specify a parameter value.
     * 
     */
    private Boolean usePreviousValue;
    /**
     * 
     * The key associated with the parameter. If you don't specify a key and
     * value for a particular parameter, AWS CloudFormation uses the default
     * value that is specified in your template.
     * 
     * 
     * @param parameterKey
     *        The key associated with the parameter. If you don't specify a key
     *        and value for a particular parameter, AWS CloudFormation uses the
     *        default value that is specified in your template.
     */
    public void setParameterKey(String parameterKey) {
        this.parameterKey = parameterKey;
    }
    /**
     * 
     * The key associated with the parameter. If you don't specify a key and
     * value for a particular parameter, AWS CloudFormation uses the default
     * value that is specified in your template.
     * 
     * 
     * @return The key associated with the parameter. If you don't specify a key
     *         and value for a particular parameter, AWS CloudFormation uses the
     *         default value that is specified in your template.
     */
    public String getParameterKey() {
        return this.parameterKey;
    }
    /**
     * 
     * The key associated with the parameter. If you don't specify a key and
     * value for a particular parameter, AWS CloudFormation uses the default
     * value that is specified in your template.
     * 
     * 
     * @param parameterKey
     *        The key associated with the parameter. If you don't specify a key
     *        and value for a particular parameter, AWS CloudFormation uses the
     *        default value that is specified in your template.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Parameter withParameterKey(String parameterKey) {
        setParameterKey(parameterKey);
        return this;
    }
    /**
     * 
     * The value associated with the parameter.
     * 
     * 
     * @param parameterValue
     *        The value associated with the parameter.
     */
    public void setParameterValue(String parameterValue) {
        this.parameterValue = parameterValue;
    }
    /**
     * 
     * The value associated with the parameter.
     * 
     * 
     * @return The value associated with the parameter.
     */
    public String getParameterValue() {
        return this.parameterValue;
    }
    /**
     * 
     * The value associated with the parameter.
     * 
     * 
     * @param parameterValue
     *        The value associated with the parameter.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Parameter withParameterValue(String parameterValue) {
        setParameterValue(parameterValue);
        return this;
    }
    /**
     * 
     * During a stack update, use the existing parameter value that the stack is
     * using for a given parameter key. If you specify true, do not
     * specify a parameter value.
     * 
     * 
     * @param usePreviousValue
     *        During a stack update, use the existing parameter value that the
     *        stack is using for a given parameter key. If you specify
     *        true, do not specify a parameter value.
     */
    public void setUsePreviousValue(Boolean usePreviousValue) {
        this.usePreviousValue = usePreviousValue;
    }
    /**
     * 
     * During a stack update, use the existing parameter value that the stack is
     * using for a given parameter key. If you specify true, do not
     * specify a parameter value.
     * 
     * 
     * @return During a stack update, use the existing parameter value that the
     *         stack is using for a given parameter key. If you specify
     *         true, do not specify a parameter value.
     */
    public Boolean getUsePreviousValue() {
        return this.usePreviousValue;
    }
    /**
     * 
     * During a stack update, use the existing parameter value that the stack is
     * using for a given parameter key. If you specify true, do not
     * specify a parameter value.
     * 
     * 
     * @param usePreviousValue
     *        During a stack update, use the existing parameter value that the
     *        stack is using for a given parameter key. If you specify
     *        true, do not specify a parameter value.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Parameter withUsePreviousValue(Boolean usePreviousValue) {
        setUsePreviousValue(usePreviousValue);
        return this;
    }
    /**
     * 
     * During a stack update, use the existing parameter value that the stack is
     * using for a given parameter key. If you specify true, do not
     * specify a parameter value.
     * 
     * 
     * @return During a stack update, use the existing parameter value that the
     *         stack is using for a given parameter key. If you specify
     *         true, do not specify a parameter value.
     */
    public Boolean isUsePreviousValue() {
        return this.usePreviousValue;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getParameterKey() != null)
            sb.append("ParameterKey: " + getParameterKey() + ",");
        if (getParameterValue() != null)
            sb.append("ParameterValue: " + getParameterValue() + ",");
        if (getUsePreviousValue() != null)
            sb.append("UsePreviousValue: " + getUsePreviousValue());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof Parameter == false)
            return false;
        Parameter other = (Parameter) obj;
        if (other.getParameterKey() == null ^ this.getParameterKey() == null)
            return false;
        if (other.getParameterKey() != null
                && other.getParameterKey().equals(this.getParameterKey()) == false)
            return false;
        if (other.getParameterValue() == null
                ^ this.getParameterValue() == null)
            return false;
        if (other.getParameterValue() != null
                && other.getParameterValue().equals(this.getParameterValue()) == false)
            return false;
        if (other.getUsePreviousValue() == null
                ^ this.getUsePreviousValue() == null)
            return false;
        if (other.getUsePreviousValue() != null
                && other.getUsePreviousValue().equals(
                        this.getUsePreviousValue()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getParameterKey() == null) ? 0 : getParameterKey()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getParameterValue() == null) ? 0 : getParameterValue()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getUsePreviousValue() == null) ? 0 : getUsePreviousValue()
                        .hashCode());
        return hashCode;
    }
    @Override
    public Parameter clone() {
        try {
            return (Parameter) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}