com.google.firebase.remoteconfig.Parameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of firebase-admin Show documentation
This is the official Firebase Admin Java SDK. Build extraordinary native JVM apps in minutes with Firebase. The Firebase platform can power your app’s backend, user authentication, static hosting, and more.
There is a newer version: 9.3.0
Show newest version
/*
 * Copyright 2020 Google LLC
 *
 * 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.remoteconfig;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.base.Strings;
import com.google.firebase.internal.NonNull;
import com.google.firebase.internal.Nullable;
import com.google.firebase.remoteconfig.internal.TemplateResponse.ParameterResponse;
import com.google.firebase.remoteconfig.internal.TemplateResponse.ParameterValueResponse;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * Represents a Remote Config parameter that can be included in a {@link Template}.
 * At minimum, a default value or a conditional value must be present for the
 * parameter to have any effect.
 */
public final class Parameter {

  private ParameterValue defaultValue;
  private String description;
  private Map conditionalValues;
  private ParameterValueType valueType;

  /**
   * Creates a new {@link Parameter}.
   */
  public Parameter() {
    conditionalValues = new HashMap<>();
  }

  Parameter(@NonNull ParameterResponse parameterResponse) {
    checkNotNull(parameterResponse);
    this.conditionalValues = new HashMap<>();
    if (parameterResponse.getConditionalValues() != null) {
      for (Map.Entry entry
              : parameterResponse.getConditionalValues().entrySet()) {
        this.conditionalValues.put(entry.getKey(),
                ParameterValue.fromParameterValueResponse(entry.getValue()));
      }
    }
    ParameterValueResponse responseDefaultValue = parameterResponse.getDefaultValue();
    this.defaultValue = (responseDefaultValue == null) ? null
            : ParameterValue.fromParameterValueResponse(responseDefaultValue);
    this.description = parameterResponse.getDescription();
    if (!Strings.isNullOrEmpty(parameterResponse.getValueType())) {
      this.valueType = ParameterValueType.valueOf(parameterResponse.getValueType());
    }
  }

  /**
   * Gets the default value of the parameter.
   *
   * @return A {@link ParameterValue} instance or null.
   */
  @Nullable
  public ParameterValue getDefaultValue() {
    return defaultValue;
  }

  /**
   * Gets the description of the parameter.
   *
   * @return The description of the parameter or null.
   */
  @Nullable
  public String getDescription() {
    return description;
  }

  /**
   * Gets the conditional values of the parameter.
   * The condition name of the highest priority (the one listed first in the
   * {@link Template}'s conditions list) determines the value of this parameter.
   *
   * @return A non-null map of conditional values.
   */
  @NonNull
  public Map getConditionalValues() {
    return conditionalValues;
  }

  /**
   * Gets the data type of the parameter value.
   *
   * @return The data type of the parameter value or null.
   */
  @Nullable
  public ParameterValueType getValueType() {
    return valueType;
  }

  /**
   * Sets the default value of the parameter.
   * This is the value to set the parameter to, when none of the named conditions
   * evaluate to true.
   *
   * @param value An {@link ParameterValue} instance.
   * @return This {@link Parameter}.
   */
  public Parameter setDefaultValue(@Nullable ParameterValue value) {
    defaultValue = value;
    return this;
  }

  /**
   * Sets the description of the parameter.
   * Should not be over 100 characters and may contain any Unicode characters.
   *
   * @param description The description of the parameter.
   * @return This {@link Parameter}.
   */
  public Parameter setDescription(@Nullable String description) {
    this.description = description;
    return this;
  }

  /**
   * Sets the conditional values of the parameter.
   * The condition name of the highest priority (the one listed first in the
   * {@link Template}'s conditions list) determines the value of this parameter.
   *
   * @param conditionalValues A non-null map of conditional values.
   * @return This {@link Parameter}.
   */
  public Parameter setConditionalValues(
          @NonNull Map conditionalValues) {
    checkNotNull(conditionalValues, "conditional values must not be null.");
    this.conditionalValues = conditionalValues;
    return this;
  }

  /**
   * Sets the data type of the parameter value.
   * Defaults to `ParameterValueType.STRING` if unspecified.
   *
   * @param valueType The data type of the parameter value.
   * @return This {@link Parameter}.
   */
  public Parameter setValueType(@Nullable ParameterValueType valueType) {
    this.valueType = valueType;
    return this;
  }

  ParameterResponse toParameterResponse() {
    Map conditionalResponseValues = new HashMap<>();
    for (Map.Entry entry : conditionalValues.entrySet()) {
      conditionalResponseValues.put(entry.getKey(), entry.getValue().toParameterValueResponse());
    }
    ParameterValueResponse defaultValueResponse = (defaultValue == null) ? null
            : defaultValue.toParameterValueResponse();
    return new ParameterResponse()
            .setDefaultValue(defaultValueResponse)
            .setDescription(description)
            .setConditionalValues(conditionalResponseValues)
            .setValueType(this.valueType == null ? null : this.valueType.getValueType());
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Parameter parameter = (Parameter) o;
    return Objects.equals(defaultValue, parameter.defaultValue)
            && Objects.equals(description, parameter.description)
            && Objects.equals(conditionalValues, parameter.conditionalValues)
            && Objects.equals(valueType, parameter.valueType);
  }

  @Override
  public int hashCode() {
    return Objects.hash(defaultValue, description, conditionalValues, valueType);
  }
}