io.sentry.event.interfaces.MessageInterface Maven / Gradle / Ivy

Go to download
package io.sentry.event.interfaces;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * The Message interface for Sentry allows to send the original pattern to Sentry, allowing the events to be grouped
 * by original message (rather than the formatted version).
 * 
 * Sentry's ability to regroup event with the same messages is based on the content of the message, meaning that an
 * {@link io.sentry.event.Event} with the message "User1 failed to provide an email address"
 * won't be grouped with an Event with the message "User2 failed to provide an email address".
 * 

 * To allow this kind of grouping, sentry supports the message interface which will provide both the pattern of the
 * message and the parameters. In this example the pattern could be:

 * {} failed to provide an email address

 * And the parameters would be User1 in the first Event and User2 in the second Event.

 * This way, Sentry will be able to put the two events in the same category.
 * 

 * Note: Sentry won't attempt to format the message, this is why the formatted message should be set through
 * {@link io.sentry.event.EventBuilder#withMessage(String)} in any case.
 */
public class MessageInterface implements SentryInterface {
    /**
     * Name of the message interface in Sentry.
     */
    public static final String MESSAGE_INTERFACE = "sentry.interfaces.Message";
    private final String message;
    private final List parameters;
    private final String formatted;

    /**
     * Creates a non parametrised message.
     * 
     * While it's technically possible to create a non parametrised message with {@code MessageInterface}, it's
     * recommended to use {@link io.sentry.event.EventBuilder#withMessage(String)} instead.
     *
     * @param message message to add to the event.
     */
    public MessageInterface(String message) {
        this(message, Collections.emptyList());
    }

    /**
     * Creates a parametrised message for an {@link io.sentry.event.Event}.
     *
     * @param message original message.
     * @param params  parameters of the message.
     */
    public MessageInterface(String message, String... params) {
        this(message, Arrays.asList(params));
    }

    /**
     * Creates a parametrised message for an {@link io.sentry.event.Event}.
     *
     * @param message    original message.
     * @param parameters parameters of the message.
     */
    public MessageInterface(String message, List parameters) {
        this(message, parameters, null);
    }

    /**
     * Creates a parametrised message for an {@link io.sentry.event.Event}.
     *
     * @param message    original message.
     * @param parameters parameters of the message.
     * @param formatted  message formatted with parameters
     */
    public MessageInterface(String message, List parameters, String formatted) {
        this.message = message;
        this.parameters = Collections.unmodifiableList(new ArrayList<>(parameters));
        this.formatted = formatted;
    }

    @Override
    public String getInterfaceName() {
        return MESSAGE_INTERFACE;
    }

    public String getMessage() {
        return message;
    }

    public List getParameters() {
        return parameters;
    }

    public String getFormatted() {
        return formatted;
    }

    @Override
    public String toString() {
        return "MessageInterface{"
            + "message='" + message + '\''
            + ", parameters=" + parameters
            + ", formatted=" + formatted
            + '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        MessageInterface that = (MessageInterface) o;
        return Objects.equals(message, that.message)
            && Objects.equals(parameters, that.parameters)
            && Objects.equals(formatted, that.formatted);
    }

    @Override
    public int hashCode() {
        return Objects.hash(message, parameters, formatted);
    }
}