com.codebullets.sagalib.timeout.Timeout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of saga-lib Show documentation
Java saga pattern library to organize and handle domain events.
The newest version!
/*
 * Copyright 2013 Stefan Domnanovits
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.codebullets.sagalib.timeout;

import com.google.common.base.MoreObjects;

import java.io.Serializable;
import java.util.Date;

/**
 * Created by the saga lib if a saga has requested a timeout and
 * the defined time has expired.
 */
public final class Timeout implements Serializable {
    private static final long serialVersionUID = 1L;

    private TimeoutId id;
    private String sagaId;
    private Date expiredAt;
    private String name;
    private Object data;

    /**
     * Use static builder method to create instance.
     */
    private Timeout() {
    }

    /**
     * Gets the id of this timeout.
     */
    public TimeoutId getId() {
        return id;
    }

    /**
     * Gets the id of the matching saga.
     */
    public String getSagaId() {
        return sagaId;
    }

    /**
     * Gets the data the timeout expired is triggered.
     */
    public Date getExpiredAt() {
        return expiredAt != null ? new Date(expiredAt.getTime()) : null;
    }

    /**
     * Gets an optional name of the timeout.
     */
    public String getName() {
        return name;
    }

    /**
     * Gets the data object of the timeout.
     */
    public Object getData() {
        return data;
    }

    /**
     * Creates a new Timeout instance.
     */
    public static Timeout create(final TimeoutId id, final String sagaId, final String name, final Date expiredAt) {
        return Timeout.create(id, sagaId, name, expiredAt, null);
    }

    /**
     * Creates a new Timeout instance.
     */
    public static Timeout create(final TimeoutId id, final String sagaId, final String name, final Date expiredAt, final Object data) {
        Timeout timeout = new Timeout();
        timeout.id = id;
        timeout.sagaId = sagaId;
        timeout.expiredAt = expiredAt;
        timeout.name = name;
        timeout.data = data;

        return timeout;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("id", id)
                .add("sagaId", sagaId)
                .add("expiredAt", expiredAt)
                .add("name", name)
                .add("data", data)
                .toString();
    }
}