com.helger.masterdata.currency.IHasCurrency Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.masterdata.currency;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.Nonempty;

/**
 * Base interface for objects having a currency.
 *
 * @author Philip Helger
 */
@FunctionalInterface
public interface IHasCurrency
{
  /**
   * @return The underlying currency. May not be null.
   */
  @Nonnull
  ECurrency getCurrency ();

  /**
   * @return The ID of the underlying currency. May not be null.
   */
  @Nonnull
  @Nonempty
  default String getCurrencyID ()
  {
    return getCurrency ().getID ();
  }
}