com.segment.analytics.messages.AliasMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of analytics-core Show documentation
The newest version!
package com.segment.analytics.messages;

import com.google.auto.value.AutoValue;
import com.segment.analytics.gson.AutoGson;
import java.util.Date;
import java.util.Map;

/**
 * The alias message is used to merge two user identities, effectively connecting two sets of user
 * data as one. This is an advanced method, but it is required to manage user identities
 * successfully in some of our integrations.
 *
 * Use {@link #builder} to construct your own instances.
 *
 * @see Alias
 */
@AutoValue
@AutoGson
public abstract class AliasMessage implements Message {

  /**
   * Start building an {@link AliasMessage} instance.
   *
   * @param previousId The previous unique identifier for the user. See the Previous ID field docs
   *     for more detail.
   * @throws IllegalArgumentException if the previousId is null or empty
   */
  public static Builder builder(String previousId) {
    return new Builder(previousId);
  }

  public abstract String previousId();

  public Builder toBuilder() {
    return new Builder(this);
  }

  /** Fluent API for creating {@link AliasMessage} instances. */
  public static class Builder extends MessageBuilder {
    private String previousId;

    private Builder(AliasMessage alias) {
      super(alias);
      previousId = alias.previousId();
    }

    private Builder(String previousId) {
      super(Type.alias);
      if (isNullOrEmpty(previousId)) {
        throw new IllegalArgumentException("previousId cannot be null or empty.");
      }
      this.previousId = previousId;
    }

    @Override
    protected AliasMessage realBuild(
        Type type,
        String messageId,
        Date sentAt,
        Date timestamp,
        Map context,
        String anonymousId,
        String userId,
        Map integrations) {
      return new AutoValue_AliasMessage(
          type,
          messageId,
          sentAt,
          timestamp,
          context,
          anonymousId,
          userId,
          integrations,
          previousId);
    }

    @Override
    Builder self() {
      return this;
    }
  }
}