BasicProjectAssertions.java

/**
 * Copyright (C) 2014 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.basics;

import com.opengamma.strata.basics.currency.CurrencyAmount;
import com.opengamma.strata.collect.CollectProjectAssertions;

/**
 * Helper class to allow custom AssertJ assertions to be
 * accessible via the same static import as the standard
 * assertions.
 * <p>
 * Prefer to statically import {@link #assertThat(CurrencyAmount)}
 * from this class rather than {@link CurrencyAmountAssert#assertThat(CurrencyAmount)}.
 */
public class BasicProjectAssertions extends CollectProjectAssertions {

  /**
   * Create an {@code Assert} instance that enables
   * assertions on {@code CurrencyAmount} objects.
   *
   * @param amount  the amount to create an {@code Assert} for
   * @return an {@code Assert} instance
   */
  public static CurrencyAmountAssert assertThat(CurrencyAmount amount) {
    return CurrencyAmountAssert.assertThat(amount);
  }
}