com.github.daytron.daytronmoney.collection.MoneyHashMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DaytronMoney Show documentation
A Java library for dealing simple monetary operations and conversions.
The newest version!
/*
 * The MIT License
 *
 * Copyright 2015 Ryan Gilera.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.daytron.daytronmoney.collection;

import com.github.daytron.daytronmoney.currency.Money;
import java.util.Map;

/**
 * Custom data structure for handling Monies that extends the capabilities of 
 * a HashMap class. Implements custom methods from 
 * MoneyCollection interface and AbstractMoneyMap abstract 
 * class.
 * 
 * @author Ryan Gilera
 * @param  A generic data type that extends Object class
 * @param  A generic data type that extends Money class
 */
public class MoneyHashMap extends AbstractMoneyMap{
    
    /**
     * Creates MoneyHashMap object with no arguments
     */
    public MoneyHashMap() {
        super();
    }
    
    /**
     * Creates MoneyHashMap object that takes an integer
     * as its initial size.
     * 
     * @param size integer value
     */
    public MoneyHashMap(int size) {
        super(size);
    }
    
    /**
     * Creates MoneyHashMap object that takes any Map
     * objects as its argument.
     * 
     * @param m Map object
     */
    public MoneyHashMap(Map m) {
        super(m);
    }
    
    /**
     * Creates MoneyHashMap object that takes an integer
     * value for initial capacity and float for load factor 
     * as its argument.
     * 
     * @param initialCapacity integer value
     * @param loadFactor float value
     */
    public MoneyHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);
    }

    /**
     * Checks of this object has negative Money objects.
     * 
     * @return boolean value
     */
    @Override
    public boolean hasNegativeValue() {
        boolean hasNegative = false;
        for (Money money : this.values()) {
            if (money.isNegative()) {
                hasNegative = true;
            }
        }
        
        return hasNegative;
    }

    /**
     * Checks of this object has positive Money objects.
     * 
     * @return boolean value
     */
    @Override
    public boolean hasPositiveValue() {
        boolean hasPositive = false;
        for (Money money : this.values()) {
            if (money.isPositive()) {
                hasPositive = true;
            }
        }
        
        return hasPositive;
    }

    /**
     * Retrieves all positive values.
     * 
     * @return MoneyHashMap object with all positive values.
     */
    @Override
    public MoneyHashMap retrieveAllPositiveValues() {
        MoneyHashMap listOfPositives = new MoneyHashMap<>();
        
        for (Entry entry : this.entrySet()) {
            if (entry.getValue().isPositive()) {
                listOfPositives.put(entry.getKey(), entry.getValue());
            }
        }
        
        return listOfPositives;
    }

    /**
     * Retrieves all negative values.
     * 
     * @return MoneyHashMap object with all negative values.
     */
    @Override
    public MoneyHashMap retrieveAllNegativeValues() {
        MoneyHashMap listOfNegatives = new MoneyHashMap<>();
        
        for (Entry entry : this.entrySet()) {
            if (entry.getValue().isNegative()) {
                listOfNegatives.put(entry.getKey(), entry.getValue());
            }
        }
        
        return listOfNegatives;
    }

    /**
     * Calculates the sum of all values stored.
     * 
     * @return Money as sum
     */
    @Override
    public Money sum() {
        Money sumMoney = new Money.Builder().build();
        for (Money money : this.values()) {
            sumMoney = sumMoney.add(money);
        }
        
        return sumMoney;
    }
    
    /**
     * Calculates the difference of all values stored.
     * 
     * @return Money as difference
     */
    @Override
    public Money difference() {
        Money differenceMoney = null;
        for (Money money : this.values()) {
            if (differenceMoney == null) {
                differenceMoney = money;
            } else {
                differenceMoney = differenceMoney.subtract(money);
            }
            
        }
        
        return differenceMoney;
    }

    /**
     * Calculates the product of all values stored.
     * 
     * @return Money as product
     */
    @Override
    public Money product() {
        Money productMoney = null;
        for (Money money : this.values()) {
            if (productMoney == null) {
                productMoney = money;
            } else {
                productMoney = productMoney.multiply(money);
            }
            
        }
        
        return productMoney;
    }

    /**
     * Calculates the quotient of all values stored.
     * 
     * @return Money object as quotient
     */
    @Override
    public Money quotient() {
        Money quotientMoney = null;
        for (Money money : this.values()) {
            if (quotientMoney == null) {
                quotientMoney = money;
            } else {
                quotientMoney = quotientMoney.divide(money);
            }
            
        }
        
            return quotientMoney;
    }

    /**
     * Calculates the sum for each values stored with the given value.
     * 
     * @param money Money object
     */
    @Override
    public void addEachWith(Money money) {
        for (Map.Entry anEntry : this.entrySet()){
            Money newMoney = anEntry.getValue().add(money);
            put(anEntry.getKey(), newMoney);
        }
    }

    /**
     * Calculates the difference for each values stored with the given value.
     * 
     * @param money Money object
     */
    @Override
    public void subtractEachWith(Money money) {
        for (Map.Entry anEntry : this.entrySet()){
            Money newMoney = anEntry.getValue().subtract(money);
            put(anEntry.getKey(), newMoney);
        }
    }

    /**
     * Calculates the product for each values stored with the given value.
     * 
     * @param money Money object
     */
    @Override
    public void multiplyEachWith(Money money) {
       for (Map.Entry anEntry : this.entrySet()){
            Money newMoney = anEntry.getValue().multiply(money);
            put(anEntry.getKey(), newMoney);
        }
    }

    /**
     * Calculates the quotient for each values stored with the given value.
     * 
     * @param money Money object
     */
    @Override
    public void divideEachWith(Money money) {
        for (Map.Entry anEntry : this.entrySet()){
            Money newMoney = anEntry.getValue().divide(money);
            put(anEntry.getKey(), newMoney);
        }
    }
    

}