com.amazonaws.services.simpleworkflow.model.History 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.simpleworkflow.model;
import java.io.Serializable;
/**
 * 
 * Paginated representation of a workflow history for a workflow execution. This
 * is the up to date, complete and authoritative record of the events related to
 * all tasks and events in the life of the workflow execution.
 * 
 */
public class History implements Serializable, Cloneable {
    /**
     * 
     * The list of history events.
     * 
     */
    private java.util.List events;
    /**
     * 
     * If a NextPageToken was returned by a previous call, there
     * are more results available. To retrieve the next page of results, make
     * the call again using the returned token in nextPageToken.
     * Keep all other arguments unchanged.
     * 
     * 
     * The configured maximumPageSize determines how many results
     * can be returned in a single call.
     * 
     */
    private String nextPageToken;
    /**
     * 
     * The list of history events.
     * 
     * 
     * @return The list of history events.
     */
    public java.util.List getEvents() {
        return events;
    }
    /**
     * 
     * The list of history events.
     * 
     * 
     * @param events
     *        The list of history events.
     */
    public void setEvents(java.util.Collection events) {
        if (events == null) {
            this.events = null;
            return;
        }
        this.events = new java.util.ArrayList(events);
    }
    /**
     * 
     * The list of history events.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setEvents(java.util.Collection)} or
     * {@link #withEvents(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param events
     *        The list of history events.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public History withEvents(HistoryEvent... events) {
        if (this.events == null) {
            setEvents(new java.util.ArrayList(events.length));
        }
        for (HistoryEvent ele : events) {
            this.events.add(ele);
        }
        return this;
    }
    /**
     * 
     * The list of history events.
     * 
     * 
     * @param events
     *        The list of history events.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public History withEvents(java.util.Collection events) {
        setEvents(events);
        return this;
    }
    /**
     * 
     * If a NextPageToken was returned by a previous call, there
     * are more results available. To retrieve the next page of results, make
     * the call again using the returned token in nextPageToken.
     * Keep all other arguments unchanged.
     * 
     * 
     * The configured maximumPageSize determines how many results
     * can be returned in a single call.
     * 
     * 
     * @param nextPageToken
     *        If a NextPageToken was returned by a previous call,
     *        there are more results available. To retrieve the next page of
     *        results, make the call again using the returned token in
     *        nextPageToken. Keep all other arguments
     *        unchanged.
     *        
     *        The configured maximumPageSize determines how many
     *        results can be returned in a single call.
     */
    public void setNextPageToken(String nextPageToken) {
        this.nextPageToken = nextPageToken;
    }
    /**
     * 
     * If a NextPageToken was returned by a previous call, there
     * are more results available. To retrieve the next page of results, make
     * the call again using the returned token in nextPageToken.
     * Keep all other arguments unchanged.
     * 
     * 
     * The configured maximumPageSize determines how many results
     * can be returned in a single call.
     * 
     * 
     * @return If a NextPageToken was returned by a previous call,
     *         there are more results available. To retrieve the next page of
     *         results, make the call again using the returned token in
     *         nextPageToken. Keep all other arguments
     *         unchanged.
     *         
     *         The configured maximumPageSize determines how many
     *         results can be returned in a single call.
     */
    public String getNextPageToken() {
        return this.nextPageToken;
    }
    /**
     * 
     * If a NextPageToken was returned by a previous call, there
     * are more results available. To retrieve the next page of results, make
     * the call again using the returned token in nextPageToken.
     * Keep all other arguments unchanged.
     * 
     * 
     * The configured maximumPageSize determines how many results
     * can be returned in a single call.
     * 
     * 
     * @param nextPageToken
     *        If a NextPageToken was returned by a previous call,
     *        there are more results available. To retrieve the next page of
     *        results, make the call again using the returned token in
     *        nextPageToken. Keep all other arguments
     *        unchanged.
     *        
     *        The configured maximumPageSize determines how many
     *        results can be returned in a single call.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public History withNextPageToken(String nextPageToken) {
        setNextPageToken(nextPageToken);
        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 (getEvents() != null)
            sb.append("Events: " + getEvents() + ",");
        if (getNextPageToken() != null)
            sb.append("NextPageToken: " + getNextPageToken());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof History == false)
            return false;
        History other = (History) obj;
        if (other.getEvents() == null ^ this.getEvents() == null)
            return false;
        if (other.getEvents() != null
                && other.getEvents().equals(this.getEvents()) == false)
            return false;
        if (other.getNextPageToken() == null ^ this.getNextPageToken() == null)
            return false;
        if (other.getNextPageToken() != null
                && other.getNextPageToken().equals(this.getNextPageToken()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getEvents() == null) ? 0 : getEvents().hashCode());
        hashCode = prime
                * hashCode
                + ((getNextPageToken() == null) ? 0 : getNextPageToken()
                        .hashCode());
        return hashCode;
    }
    @Override
    public History clone() {
        try {
            return (History) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}