google-nomulus/java/google/registry/model/domain/fee/FeeTransformResponseExtension.java

// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.model.domain.fee;

import static google.registry.util.CollectionUtils.forceEmptyToNull;
import static google.registry.util.CollectionUtils.nullToEmptyImmutableCopy;

import com.google.common.collect.ImmutableList;
import google.registry.model.Buildable;
import google.registry.model.ImmutableObject;
import google.registry.model.eppoutput.EppResponse.ResponseExtension;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;
import org.joda.money.CurrencyUnit;

/** Base class for fee responses on general transform commands (create, update, renew, transfer). */
@XmlTransient
public class FeeTransformResponseExtension extends ImmutableObject implements ResponseExtension {

  /** The currency of the fee. */
  CurrencyUnit currency;

  /**
   * The magnitude of the fee, in the specified units, with an optional description.
   *
   * <p>This is a list because a single operation can involve multiple fees.
   */
  @XmlElement(name = "fee")
  List<Fee> fees;

  /** This field is exposed to JAXB only via the getter so that subclasses can override it. */
  @XmlTransient
  List<Credit> credits;

  @XmlElement(name = "credit")
  public ImmutableList<Credit> getCredits() {
    return nullToEmptyImmutableCopy(credits);
  }

  /** Abstract builder for {@link FeeTransformResponseExtension}. */
  public static class Builder extends Buildable.Builder<FeeTransformResponseExtension> {

    public Builder(FeeTransformResponseExtension instance) {
      super(instance);
    }

    public Builder setCurrency(CurrencyUnit currency) {
      getInstance().currency = currency;
      return this;
    }

    public Builder setFees(List<Fee> fees) {
      getInstance().fees = fees;
      return this;
    }

    public Builder setCredits(List<Credit> credits) {
      getInstance().credits = forceEmptyToNull(credits);
      return this;
    }
  }
}