com.phloc.masterdata.price.ReadonlyPrice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-masterdata Show documentation
Library with support for certain re-ocurring standard business objects
There is a newer version: 3.7.6
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.masterdata.price;

import java.math.BigDecimal;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.masterdata.currency.ECurrency;
import com.phloc.masterdata.currency.IReadonlyCurrencyValue;
import com.phloc.masterdata.currency.ReadonlyCurrencyValue;
import com.phloc.masterdata.vat.IVATItem;

/**
 * Default implementation of the {@link IReadonlyPrice} interface.
 * 
 * @author Philip Helger
 */
public class ReadonlyPrice implements IReadonlyPrice
{
  private final IReadonlyCurrencyValue m_aNetAmount;
  private final IVATItem m_aVATItem;

  public ReadonlyPrice (@Nonnull final IReadonlyPrice aOtherPrice)
  {
    this (aOtherPrice.getNetAmount (), aOtherPrice.getVATItem ());
  }

  public ReadonlyPrice (@Nonnull final ECurrency eCurrency,
                        @Nonnull final BigDecimal aNetAmount,
                        @Nonnull final IVATItem aVATItem)
  {
    m_aNetAmount = new ReadonlyCurrencyValue (eCurrency, aNetAmount);
    m_aVATItem = ValueEnforcer.notNull (aVATItem, "VATItem");
  }

  public ReadonlyPrice (@Nonnull final IReadonlyCurrencyValue aNetAmount, @Nonnull final IVATItem aVATItem)
  {
    ValueEnforcer.notNull (aNetAmount, "NetAmount");
    // Make a copy of the net amount!
    m_aNetAmount = new ReadonlyCurrencyValue (aNetAmount);
    m_aVATItem = ValueEnforcer.notNull (aVATItem, "VATItem");
  }

  @Nonnull
  public ECurrency getCurrency ()
  {
    return m_aNetAmount.getCurrency ();
  }

  @Nonnull
  public IReadonlyCurrencyValue getNetAmount ()
  {
    return m_aNetAmount;
  }

  @Nonnull
  public IReadonlyCurrencyValue getGrossAmount ()
  {
    final BigDecimal aMultiplicationFactor = m_aVATItem.getMultiplicationFactorNetToGross ();
    return m_aNetAmount.getMultiplied (aMultiplicationFactor);
  }

  @Nonnull
  public IVATItem getVATItem ()
  {
    return m_aVATItem;
  }

  @Nonnull
  public IReadonlyCurrencyValue getTaxAmount ()
  {
    return m_aNetAmount.getMultiplied (m_aVATItem.getPercentageFactor ());
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getAdded (@Nonnull final BigDecimal aValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getAdded (aValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getAdded (final long nValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getAdded (nValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getSubtracted (@Nonnull final BigDecimal aValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getSubtracted (aValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getSubtracted (final long nValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getSubtracted (nValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getMultiplied (@Nonnull final BigDecimal aValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getMultiplied (aValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getMultiplied (final long nValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getMultiplied (nValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getDivided (@Nonnull final BigDecimal aValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getDivided (aValue), m_aVATItem);
  }

  @Nonnull
  @CheckReturnValue
  public ReadonlyPrice getDivided (final long nValue)
  {
    return new ReadonlyPrice (m_aNetAmount.getDivided (nValue), m_aVATItem);
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final ReadonlyPrice rhs = (ReadonlyPrice) o;
    return m_aNetAmount.equals (rhs.m_aNetAmount) && m_aVATItem.equals (rhs.m_aVATItem);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_aNetAmount).append (m_aVATItem).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("netAmount", m_aNetAmount).append ("VATItem", m_aVATItem).toString ();
  }
}