FcmOptions.java

/*
 * 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.google.firebase.messaging;

import com.google.api.client.util.Key;

/**
 * Represents the platform-independent FCM options that can be included in a {@link Message}.
 * Instances of this class are thread-safe and immutable.
 */
public final class FcmOptions {

  @Key("analytics_label")
  private final String analyticsLabel;

  private FcmOptions(Builder builder) {
    FcmOptionsUtil.checkAnalyticsLabel(builder.analyticsLabel);
    this.analyticsLabel = builder.analyticsLabel;
  }

  /**
   * Creates a new {@link FcmOptions} object with the specified analytics label.
   *
   * @param analyticsLabel An analytics label
   * @return An {@link FcmOptions} object with the analytics label set to the supplied value.
   */
  public static FcmOptions withAnalyticsLabel(String analyticsLabel) {
    return new Builder().setAnalyticsLabel(analyticsLabel).build();
  }

  /**
   * Creates a new {@link FcmOptions.Builder}.
   *
   * @return An {@link FcmOptions.Builder} instance.
   */
  public static Builder builder() {
    return new Builder();
  }

  public static class Builder {

    private String analyticsLabel;

    private Builder() {}

    /**
     * @param analyticsLabel A string representing the analytics label used for messages where no
     *     platform-specific analytics label has been specified.
     * @return This builder
     */
    public Builder setAnalyticsLabel(String analyticsLabel) {
      this.analyticsLabel = analyticsLabel;
      return this;
    }

    /**
     * Creates a new {@link FcmOptions} instance from the parameters set on this builder.
     *
     * @return A new {@link FcmOptions} instance.
     * @throws IllegalArgumentException If any of the parameters set on the builder are invalid.
     */
    public FcmOptions build() {
      return new FcmOptions(this);
    }
  }
}