Fixed several quality issues.

atsticks · atsticks · commit 4d33629180ea · 2018-04-03T19:56:58.000+02:00
diff --git a/calc/bnd.bnd b/calc/bnd.bnd
@@ -0,0 +1,30 @@
+-buildpath: \
+	osgi.annotation; version=6.0.0,\
+	osgi.core; version=6.0,\
+	osgi.cmpn; version=6.0
+
+-testpath: \
+	${junit}
+
+javac.source: 1.8
+javac.target: 1.8
+
+Automatic-Module-Name: org.javamoney.moneta.calc
+Bundle-Version: ${version}.${tstamp}
+Bundle-Name: JavaMoney Moneta Calculations
+Bundle-SymbolicName: org.javamoney.moneta.calc
+Bundle-Description: JavaMoney - Calculation Library
+Bundle-Category: Implementation
+Bundle-Copyright: (C) Credit Suisse AG
+Bundle-License: Apache License, Version 2.0
+Bundle-Vendor: Credit Suisse AG
+Bundle-DocURL: http://www.javamoney.org
+Import-Package: \
+	javax.money,\
+    javax.money.spi,\
+    org.javamoney.moneta
+Export-Package: \
+	org.javamoney.calc,\
+    org.javamoney.calc.banking,\
+    org.javamoney.calc.common,\
+    org.javamoney.calc.securities
diff --git a/calc/src/main/java/org/javamoney/calc/CalculationContext.java b/calc/src/main/java/org/javamoney/calc/CalculationContext.java
@@ -26,7 +26,7 @@
  */
 public final class CalculationContext {
 
-    private static CalculationContext instance = new CalculationContext();
+    private static final CalculationContext instance = new CalculationContext();
 
     private MathContext mathContext;
     private BigDecimal one;
diff --git a/calc/src/main/java/org/javamoney/calc/CompositeMonetaryOperator.java b/calc/src/main/java/org/javamoney/calc/CompositeMonetaryOperator.java
@@ -35,7 +35,7 @@
  */
 public class CompositeMonetaryOperator implements MonetaryOperator {
 
-    private List<MonetaryOperator> functions = new ArrayList<>();
+    private final List<MonetaryOperator> functions = new ArrayList<>();
 
     @SafeVarargs
     public CompositeMonetaryOperator(Iterable<MonetaryOperator>... operations) {
diff --git a/calc/src/main/java/org/javamoney/calc/ValidatedAmount.java b/calc/src/main/java/org/javamoney/calc/ValidatedAmount.java
@@ -51,7 +51,7 @@ public final class ValidatedAmount {
      * Creates an unsigned {@link MonetaryAmount} based on the given
      * {@link MonetaryAmount}.
      *
-     * @param amount
+     * @param amount the amount to be decorated to be unsigned, not null
      * @return an ansigned instance, that can never be negative.
      */
     public static MonetaryAmount unsignedAmount(MonetaryAmount amount) {
diff --git a/calc/src/main/java/org/javamoney/calc/ValidatedMoney.java b/calc/src/main/java/org/javamoney/calc/ValidatedMoney.java
@@ -84,9 +84,9 @@ final class ValidatedMoney implements
     /**
      * Access an {@link ValidatedMoney} based on the given
      * {@link MonetaryAmount}.
-     *
-     * @param amount
-     * @return
+     * @param predicate the validation function, not null.
+     * @param amount the amount to decorate
+     * @return the decorated (validated) amount instance.
      */
     private static ValidatedMoney of(MonetaryAmount amount,
                                      Predicate<MonetaryAmount> predicate) {
diff --git a/calc/src/main/java/org/javamoney/calc/common/FutureValue.java b/calc/src/main/java/org/javamoney/calc/common/FutureValue.java
@@ -20,10 +20,8 @@
 import org.javamoney.calc.CalculationContext;
 
 import java.math.BigDecimal;
-import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * Future Value (FV) is a formula used in finance to calculate the value of a cash flow at a later
diff --git a/calc/src/main/java/org/javamoney/calc/common/FutureValueOfAnnuityDue.java b/calc/src/main/java/org/javamoney/calc/common/FutureValueOfAnnuityDue.java
@@ -20,9 +20,7 @@
 import org.javamoney.calc.CalculationContext;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 import java.math.BigDecimal;
-import java.util.Objects;
 
 /**
  * <img src="http://www.financeformulas.net/Formula%20Images/Annuity%20Due%20-%20FV%201.gif" />
diff --git a/calc/src/main/java/org/javamoney/calc/common/FutureValueOfAnnuityWithContCompounding.java b/calc/src/main/java/org/javamoney/calc/common/FutureValueOfAnnuityWithContCompounding.java
@@ -23,7 +23,6 @@
 import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * <img src=
diff --git a/calc/src/main/java/org/javamoney/calc/common/FutureValueWithContinuousCompounding.java b/calc/src/main/java/org/javamoney/calc/common/FutureValueWithContinuousCompounding.java
@@ -18,7 +18,6 @@
 package org.javamoney.calc.common;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 import com.ibm.icu.math.BigDecimal;
 
diff --git a/calc/src/main/java/org/javamoney/calc/common/PresentValue.java b/calc/src/main/java/org/javamoney/calc/common/PresentValue.java
@@ -20,7 +20,6 @@
 import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * <img src= "http://www.financeformulas.net/Formula%20Images/Present%20Value%203.gif" />
diff --git a/calc/src/main/java/org/javamoney/calc/common/PresentValueGrowingAnnuityPayment.java b/calc/src/main/java/org/javamoney/calc/common/PresentValueGrowingAnnuityPayment.java
@@ -23,7 +23,6 @@
 import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * <p>
@@ -48,14 +47,13 @@
  */
 public final class PresentValueGrowingAnnuityPayment extends AbstractRateAndPeriodBasedOperator {
 
-    private Rate growthRate;
+    private final Rate growthRate;
 
     /**
      * Constructor.
      *
      * @param discountRateAndPeriods The discount rate and target periods, not null.
      * @param growthRate   The growth rate, not null.
-     * @return the operator, never null.
      */
     private PresentValueGrowingAnnuityPayment(RateAndPeriods discountRateAndPeriods, Rate growthRate) {
         super(discountRateAndPeriods);
diff --git a/calc/src/main/java/org/javamoney/calc/common/PresentValueOfAnnuityDue.java b/calc/src/main/java/org/javamoney/calc/common/PresentValueOfAnnuityDue.java
@@ -22,7 +22,6 @@
 import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * The formula for the present value of an annuity due,
diff --git a/calc/src/main/java/org/javamoney/calc/common/PresentValueOfAnnuityPaymentFactor.java b/calc/src/main/java/org/javamoney/calc/common/PresentValueOfAnnuityPaymentFactor.java
@@ -20,7 +20,6 @@
 import static org.javamoney.calc.CalculationContext.mathContext;
 import static org.javamoney.calc.CalculationContext.one;
 
-import javax.money.MonetaryException;
 import java.math.BigDecimal;
 import java.util.Objects;
 
diff --git a/calc/src/main/java/org/javamoney/calc/common/PresentValueOfPerpetuity.java b/calc/src/main/java/org/javamoney/calc/common/PresentValueOfPerpetuity.java
@@ -47,7 +47,7 @@
  */
 public final class PresentValueOfPerpetuity implements MonetaryOperator {
 
-    private Rate rate;
+    private final Rate rate;
 
     private PresentValueOfPerpetuity(Rate rate) {
         this.rate = Objects.requireNonNull(rate);
diff --git a/calc/src/main/java/org/javamoney/calc/common/Rate.java b/calc/src/main/java/org/javamoney/calc/common/Rate.java
@@ -36,9 +36,9 @@
  */
 public final class Rate implements MonetaryOperator, Supplier<BigDecimal> {
     /** The rate factor. */
-	private BigDecimal rate;
+	private final BigDecimal rate;
 	/** An optional rate info. */
-	private String info;
+	private final String info;
 
 	/** A general zero rate. */
 	public static final Rate ZERO = new Rate(BigDecimal.ZERO, null);
@@ -140,7 +140,7 @@ public boolean equals(Object obj) {
 	/**
 	 * Access the rate, never {@code null}.
 	 * 
-	 * @return
+	 * @return the converson rate, not null.
 	 */
     @Override
     public BigDecimal get() {
diff --git a/calc/src/main/java/org/javamoney/calc/common/SimpleInterest.java b/calc/src/main/java/org/javamoney/calc/common/SimpleInterest.java
@@ -23,7 +23,6 @@
 import java.util.Objects;
 
 import javax.money.MonetaryAmount;
-import javax.money.MonetaryOperator;
 
 /**
  * <img src= "http://www.financeformulas.net/Formula%20Images/Simple%20Interest%201.gif" />
diff --git a/calc/src/main/java/org/javamoney/calc/common/WeightedAverage.java b/calc/src/main/java/org/javamoney/calc/common/WeightedAverage.java
@@ -54,8 +54,8 @@ public final class WeightedAverage {
 	 * A weighted value is a value also with a weight attached.
 	 */
 	public static final class WeightedValue{
-		private BigDecimal value;
-		private BigDecimal weight;
+		private final BigDecimal value;
+		private final BigDecimal weight;
 		private WeightedValue(BigDecimal value, BigDecimal weight){
 			this.value = Objects.requireNonNull(value);
 			this.weight = Objects.requireNonNull(weight);
diff --git a/calc/src/main/java/org/javamoney/calc/securities/PreferredStock.java b/calc/src/main/java/org/javamoney/calc/securities/PreferredStock.java
@@ -34,7 +34,7 @@
 public class PreferredStock implements MonetaryOperator {
 
 	
-	private Rate discountRate;
+	private final Rate discountRate;
 	
     /**
      * Private constructor.
diff --git a/calc/src/main/java/org/javamoney/calc/securities/StockPresentValue.java b/calc/src/main/java/org/javamoney/calc/securities/StockPresentValue.java
@@ -35,9 +35,9 @@
 public class StockPresentValue implements MonetaryOperator {
 
 	
-	private Rate requiredRateOfReturn;
+	private final Rate requiredRateOfReturn;
 	
-	private Rate growthRate;
+	private final Rate growthRate;
 	
     /**
      * Private constructor.
@@ -71,7 +71,6 @@ public static StockPresentValue of(Rate requiredRateOfReturn, Rate growthRate) {
      *
      * @param estimatedDividends   the estimated dividends for next period
      * @param requiredRateOfReturn the required rate of return
-     * @param the                  growth rate
      * @return the present value of the stock
      */
     public static MonetaryAmount calculateForConstantGrowth(MonetaryAmount estimatedDividends, Rate requiredRateOfReturn, Rate growthRate) {
diff --git a/calc/src/main/java/org/javamoney/calc/securities/ZeroCouponBondValue.java b/calc/src/main/java/org/javamoney/calc/securities/ZeroCouponBondValue.java
@@ -34,9 +34,9 @@
 public class ZeroCouponBondValue implements MonetaryOperator {
 
 	
-	private Rate rate;
+	private final Rate rate;
 	
-	private int numberOfYearsToMaturity;
+	private final int numberOfYearsToMaturity;
 	
     /**
      * Private constructor.

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public final class ValidatedAmount {`
`51`	`51`	`* Creates an unsigned {@link MonetaryAmount} based on the given`
`52`	`52`	`* {@link MonetaryAmount}.`
`53`	`53`	`*`
`54`		`- * @param amount`
	`54`	`+ * @param amount the amount to be decorated to be unsigned, not null`
`55`	`55`	`* @return an ansigned instance, that can never be negative.`
`56`	`56`	`*/`
`57`	`57`	`public static MonetaryAmount unsignedAmount(MonetaryAmount amount) {`