com.amazonaws.services.simpleemail.model.Message Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-ses Show documentation
The AWS Java SDK for Amazon SES module holds the client classes that are used for communicating with Amazon Simple Email Service
There is a newer version: 1.12.780
Show newest version
/*
 * 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.simpleemail.model;

import java.io.Serializable;

/**
 * 
 * Represents the message to be sent, composed of a subject and a body.
 * 
 */
public class Message implements Serializable, Cloneable {

    /**
     * 
     * The subject of the message: A short summary of the content, which will
     * appear in the recipient's inbox.
     * 
     */
    private Content subject;
    /**
     * 
     * The message body.
     * 
     */
    private Body body;

    /**
     * Default constructor for Message object. Callers should use the setter or
     * fluent setter (with...) methods to initialize the object after creating
     * it.
     */
    public Message() {
    }

    /**
     * Constructs a new Message object. Callers should use the setter or fluent
     * setter (with...) methods to initialize any additional object members.
     * 
     * @param subject
     *        The subject of the message: A short summary of the content, which
     *        will appear in the recipient's inbox.
     * @param body
     *        The message body.
     */
    public Message(Content subject, Body body) {
        setSubject(subject);
        setBody(body);
    }

    /**
     * 
     * The subject of the message: A short summary of the content, which will
     * appear in the recipient's inbox.
     * 
     * 
     * @param subject
     *        The subject of the message: A short summary of the content, which
     *        will appear in the recipient's inbox.
     */

    public void setSubject(Content subject) {
        this.subject = subject;
    }

    /**
     * 
     * The subject of the message: A short summary of the content, which will
     * appear in the recipient's inbox.
     * 
     * 
     * @return The subject of the message: A short summary of the content, which
     *         will appear in the recipient's inbox.
     */

    public Content getSubject() {
        return this.subject;
    }

    /**
     * 
     * The subject of the message: A short summary of the content, which will
     * appear in the recipient's inbox.
     * 
     * 
     * @param subject
     *        The subject of the message: A short summary of the content, which
     *        will appear in the recipient's inbox.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Message withSubject(Content subject) {
        setSubject(subject);
        return this;
    }

    /**
     * 
     * The message body.
     * 
     * 
     * @param body
     *        The message body.
     */

    public void setBody(Body body) {
        this.body = body;
    }

    /**
     * 
     * The message body.
     * 
     * 
     * @return The message body.
     */

    public Body getBody() {
        return this.body;
    }

    /**
     * 
     * The message body.
     * 
     * 
     * @param body
     *        The message body.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Message withBody(Body body) {
        setBody(body);
        return this;
    }

    /**
     * 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 (getSubject() != null)
            sb.append("Subject: " + getSubject() + ",");
        if (getBody() != null)
            sb.append("Body: " + getBody());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof Message == false)
            return false;
        Message other = (Message) obj;
        if (other.getSubject() == null ^ this.getSubject() == null)
            return false;
        if (other.getSubject() != null
                && other.getSubject().equals(this.getSubject()) == false)
            return false;
        if (other.getBody() == null ^ this.getBody() == null)
            return false;
        if (other.getBody() != null
                && other.getBody().equals(this.getBody()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode
                + ((getSubject() == null) ? 0 : getSubject().hashCode());
        hashCode = prime * hashCode
                + ((getBody() == null) ? 0 : getBody().hashCode());
        return hashCode;
    }

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