BreadcrumbBuilder.java

package com.getsentry.raven.event;

import java.util.Date;
import java.util.Map;

/**
 * Builder to assist the creation of {@link Breadcrumb}s.
 */
public class BreadcrumbBuilder {

    private Breadcrumb.Type type;
    private Date timestamp;
    private Breadcrumb.Level level;
    private String message;
    private String category;
    private Map<String, String> data;

    /**
     * Type of the {@link Breadcrumb}.
     *
     * @param newType {@link Breadcrumb.Type}
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setType(Breadcrumb.Type newType) {
        this.type = newType;
        return this;
    }

    /**
     * Timestamp of the {@link Breadcrumb}.
     *
     * @param newTimestamp Date
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setTimestamp(Date newTimestamp) {
        this.timestamp = new Date(newTimestamp.getTime());
        return this;
    }

    /**
     * Level of the {@link Breadcrumb}.
     *
     * @param newLevel {@link Breadcrumb.Level}
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setLevel(Breadcrumb.Level newLevel) {
        this.level = newLevel;
        return this;
    }

    /**
     * Message of the {@link Breadcrumb}. At least one of message or
     * data is required.
     *
     * @param newMessage String
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setMessage(String newMessage) {
        this.message = newMessage;
        return this;
    }

    /**
     * Category of the {@link Breadcrumb}.
     *
     * @param newCategory String
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setCategory(String newCategory) {
        this.category = newCategory;
        return this;
    }

    /**
     * Data related to the {@link Breadcrumb}. At least one of message or
     * data is required.
     *
     * @param newData Map of String to String
     * @return current BreadcrumbBuilder
     */
    public BreadcrumbBuilder setData(Map<String, String> newData) {
        this.data = newData;
        return this;
    }

    /**
     * Build and return the {@link Breadcrumb} object.
     *
     * @return Breadcrumb
     */
    public Breadcrumb build() {
        return new Breadcrumb(type, timestamp, level, message, category, data);
    }

}