org.sisioh.baseunits.scala.money.Tally.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of baseunits-scala_2.11 Show documentation

baseunits-scala

There is a newer version: 0.1.22

/*
 * Copyright 2011 Sisioh Project and the Others.
 * lastModified : 2011/04/22
 *
 * This file is part of Tricreo.
 *
 * 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 org.sisioh.baseunits.scala.money

import java.util.Currency

import collection.Iterator

/**
 * 同じ通貨単位の金額の集合をあらわすクラス。
 *
 * @author j5ik2o
 * @param monies [[Money]]の`Iterable`
 */
class Tally(private[money] val monies: Iterable[Money])
    extends Iterable[Money] {

  /**
   * インスタンスを生成する。
   *
   * @param monies [[Money]]の可変引数
   */
  def this(monies: Money*) = this(monies.toIterable)

  private[this] val _currency = currency

  require(monies.exists(_.breachEncapsulationOfCurrency == _currency))

  /**
   * 通貨単位を返す。
   * @return 通貨単位
   */
  lazy val currency: Currency =
    monies.head.breachEncapsulationOfCurrency

  /**
   * 合計金額を返す。
   * @return 合計
   */
  lazy val net: Money = Money.sum(monies)

  override def toString() = monies.toString()

  def iterator: Iterator[Money] = monies.iterator

}

/**
 * `Tally`コンパニオンオブジェクト。
 *
 * @author j5ik2o
 */
object Tally {

  /**
   * インスタンスを生成する。
   *
   * @param monies [[Money]]の`Iterable`
   * @return [[Tally]]
   */
  def apply(monies: Iterable[Money]): Tally = new Tally(monies)

  /**
   * 抽出子メソッド。
   *
   * @param tally [[Tally]]
   * @return `Option[Iterable[Money]]`
   */
  def unapply(tally: Tally): Option[Iterable[Money]] = Some(tally.monies)

}